Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## [Unreleased]

### Removed
* Remove `docs/Dockerfile` (used for mybinder.org Binder integration) and mybinder badge links from documentation pages. The Binder integration relied on a deprecated .NET 7 SDK image and a deprecated `Microsoft.dotnet-interactive` version; mybinder.org support is discontinued.
* Remove `.ipynb` (Jupyter Notebook) "run in notebook" badge links from all documentation pages and delete `docs/img/badge-notebook.svg`. The links linked to `.ipynb` outputs generated by fsdocs, but .NET Interactive (which powered those notebooks) is deprecated and has no current replacement. The `.ipynb` output format itself is unchanged.

## [22.0.1] - 2026-04-19

### Changed
Expand Down
29 changes: 0 additions & 29 deletions docs/Dockerfile

This file was deleted.

7 changes: 1 addition & 6 deletions docs/apidocs.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@ index: 7
let root = "C:\\"

(**
[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb) 
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx) 
[![Notebook](img/badge-notebook.svg)]({{root}}/{{fsdocs-source-basename}}.ipynb)
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)

API Documentation Generation
====================================
Expand Down Expand Up @@ -194,7 +192,6 @@ module Forest =
/// </summary>
let findSquirrels (limit : int) = []


(** You can find the correct value for `cref` in the generated `.xml` documentation file (this will be generated alongside the assembly's `.dll``).

You can also omit the `cref`'s arguments, and `fsdocs` will make an attempt to find the first member that matches.
Expand All @@ -207,7 +204,6 @@ For example:
If the member cannot be found, a link to the containing module/type will be used instead.
*)


(**
### Classic XMl Doc Comments: Excluding APIs from the docs

Expand Down Expand Up @@ -363,7 +359,6 @@ module Bar2 =

(**


## Building library documentation programmatically

You can build library documentation programmatically using the functionality
Expand Down
5 changes: 1 addition & 4 deletions docs/codeformat.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ index: 1
#endif // IPYNB

(**
[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)&emsp;
[![Notebook](img/badge-notebook.svg)]({{root}}/{{fsdocs-source-basename}}.ipynb)
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)

Code formatting
==============================
Expand Down Expand Up @@ -77,7 +75,6 @@ A single source file can include multiple snippets using the same formatting tag
as those used on [fssnip.net](http://www.fssnip.net) as documented in the
[about page](http://www.fssnip.net/pages/About).


Working with returned tokens
----------------------------

Expand Down
10 changes: 1 addition & 9 deletions docs/content.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,8 @@ index: 6
#r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
#endif // IPYNB


(**
[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)&emsp;
[![Notebook](img/badge-notebook.svg)]({{root}}/{{fsdocs-source-basename}}.ipynb)
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)

Creating Content
===================================
Expand Down Expand Up @@ -225,11 +222,6 @@ of the document is placed.
To generate .ipynb output for each script and markdown file, add a `_template.ipynb`, usually empty. Substitutions are
applied to this template.

To add a `mybinder` badge to your generated notebook, ensure you have a `Dockerfile` and `NuGet.config`
in your `docs` directory and use text like this:

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fsprojects/FSharp.Formatting/gh-pages?filepath=literate.ipynb)

## Generating Script outputs

To generate .fsx output for each script and markdown file, add a `_template.fsx`, usually empty. Substitutions are
Expand Down
6 changes: 1 addition & 5 deletions docs/evaluation.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,10 @@ index: 8
#endif // IPYNB

(**
[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)&emsp;
[![Notebook](img/badge-notebook.svg)]({{root}}/{{fsdocs-source-basename}}.ipynb)
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)

# Embedding script output


For literate F# scripts, you may embed the result of running the script as part of the literate output.
This is a feature of the functions discussed in [literate programming](literate.html) and
it is implemented using the [F# Compiler service](http://fsharp.github.io/FSharp.Compiler.Service/).
Expand All @@ -51,7 +48,6 @@ To include the a formatted value use ``include-it``:

(*** include-it ***)


To include the meta output of F# Interactive processing such as type signatures use `(*** include-fsi-output ***)`:

let test = 40 + 3
Expand Down
1 change: 0 additions & 1 deletion docs/img/badge-binder.svg

This file was deleted.

1 change: 0 additions & 1 deletion docs/img/badge-notebook.svg

This file was deleted.

5 changes: 1 addition & 4 deletions docs/literate.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,8 @@ index: 4
#r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
#endif // IPYNB


(**
[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)&emsp;
[![Notebook](img/badge-notebook.svg)]({{root}}/{{fsdocs-source-basename}}.ipynb)
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)

Literate Scripts
================
Expand Down
6 changes: 1 addition & 5 deletions docs/markdown.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,8 @@ index: 2
#r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
#endif // IPYNB


(**
[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)&emsp;
[![Notebook](img/badge-notebook.svg)]({{root}}/{{fsdocs-source-basename}}.ipynb)
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)

Markdown parser
==============================
Expand All @@ -37,7 +34,6 @@ First, we need to load the assembly and open the necessary namespaces:
open FSharp.Formatting.Markdown
open FSharp.Formatting.Common


(**
Parsing documents
-----------------
Expand Down
4 changes: 1 addition & 3 deletions docs/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,7 @@ Here are the typical steps to upgrade a repo based on `ProjectScaffold` to use `

7. Consider creating `docs\_template.fsx` and `docs\_template.ipynb` to enable co-generation of F# scripts and F# notebooks.

If you add support for notebooks and scripts, consider adding mybinder links to each of your literate executable content pages. For example [like this](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/literate.fsx#L19).

Also add load sections to make sure your notebooks and scripts contain the right content to load packages out of repo. For example [like this](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/literate.fsx#L1).
Add load sections to make sure your notebooks and scripts contain the right content to load packages out of repo. For example [like this](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/literate.fsx#L1).

Sample commands:

Expand Down
1 change: 0 additions & 1 deletion src/fsdocs-tool/fsdocs-tool.fsproj
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
<Content Include="..\..\docs\_template.md" PackagePath="templates" />
<Content Include="..\..\docs\_template.tex" PackagePath="templates" />
<Content Include="..\..\docs\_template.ipynb" PackagePath="templates" />
<Content Include="..\..\docs\Dockerfile" PackagePath="extras" />
<Content Include="..\..\docs\NuGet.config" PackagePath="extras" />
<Content Include="..\..\docs\content\*" PackagePath="extras\content" />
<Content Include="..\..\docs\content\img\*" PackagePath="extras\content\img" />
Expand Down
Loading