Skip to content

Commit da83d96

Browse files
github-actions[bot]Copilotdsymenojaf
authored
[repo-assist] remove: Dockerfile and mybinder badge/documentation (#1204)
* remove: Dockerfile and mybinder badge/documentation Remove the docs/Dockerfile (used for mybinder.org Binder integration) and all mybinder badge links from the six documentation .fsx pages. Also remove the mybinder documentation section from content.fsx and the mybinder recommendation from upgrade.md. The Binder integration relied on a deprecated .NET 7 SDK image and a deprecated Microsoft.dotnet-interactive version; mybinder.org support is discontinued per maintainer decision. Closes #1178 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * ci: trigger checks * fix: remove Dockerfile reference from fsdocs-tool.fsproj The docs/Dockerfile was deleted as part of the mybinder removal, but the NuGet pack content reference in fsdocs-tool.fsproj was not updated, causing NU5019 build failure. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * ci: trigger checks * Remove .ipynb notebook badge links and badge-notebook.svg from docs .NET Interactive is deprecated and there is no current replacement. The badge links served no practical purpose. The .ipynb output format itself is unchanged. Requested by @dsyme in response to suggestion by @nhirschey. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * ci: trigger checks * Move to unreleased --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Don Syme <dsyme@users.noreply.github.com> Co-authored-by: Florian Verdonck <florian.verdonck@outlook.com>
1 parent 09fd23b commit da83d96

12 files changed

Lines changed: 13 additions & 68 deletions

RELEASE_NOTES.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Changelog
22

3+
## [Unreleased]
4+
5+
### Removed
6+
* 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.
7+
* 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.
8+
39
## [22.1.0] - 2026-05-22
410

511
### Changed

docs/Dockerfile

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/apidocs.fsx

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,7 @@ index: 7
2727
let root = "C:\\"
2828

2929
(**
30-
[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;
31-
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)&emsp;
32-
[![Notebook](img/badge-notebook.svg)]({{root}}/{{fsdocs-source-basename}}.ipynb)
30+
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)
3331
3432
API Documentation Generation
3533
====================================
@@ -194,7 +192,6 @@ module Forest =
194192
/// </summary>
195193
let findSquirrels (limit : int) = []
196194

197-
198195
(** You can find the correct value for `cref` in the generated `.xml` documentation file (this will be generated alongside the assembly's `.dll``).
199196
200197
You can also omit the `cref`'s arguments, and `fsdocs` will make an attempt to find the first member that matches.
@@ -207,7 +204,6 @@ For example:
207204
If the member cannot be found, a link to the containing module/type will be used instead.
208205
*)
209206

210-
211207
(**
212208
### Classic XMl Doc Comments: Excluding APIs from the docs
213209
@@ -363,7 +359,6 @@ module Bar2 =
363359

364360
(**
365361
366-
367362
## Building library documentation programmatically
368363
369364
You can build library documentation programmatically using the functionality

docs/codeformat.fsx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@ index: 1
2222
#endif // IPYNB
2323

2424
(**
25-
[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;
26-
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)&emsp;
27-
[![Notebook](img/badge-notebook.svg)]({{root}}/{{fsdocs-source-basename}}.ipynb)
25+
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)
2826
2927
Code formatting
3028
==============================
@@ -77,7 +75,6 @@ A single source file can include multiple snippets using the same formatting tag
7775
as those used on [fssnip.net](http://www.fssnip.net) as documented in the
7876
[about page](http://www.fssnip.net/pages/About).
7977
80-
8178
Working with returned tokens
8279
----------------------------
8380

docs/content.fsx

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,8 @@ index: 6
2121
#r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
2222
#endif // IPYNB
2323

24-
2524
(**
26-
[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;
27-
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)&emsp;
28-
[![Notebook](img/badge-notebook.svg)]({{root}}/{{fsdocs-source-basename}}.ipynb)
25+
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)
2926
3027
Creating Content
3128
===================================
@@ -225,11 +222,6 @@ of the document is placed.
225222
To generate .ipynb output for each script and markdown file, add a `_template.ipynb`, usually empty. Substitutions are
226223
applied to this template.
227224

228-
To add a `mybinder` badge to your generated notebook, ensure you have a `Dockerfile` and `NuGet.config`
229-
in your `docs` directory and use text like this:
230-
231-
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fsprojects/FSharp.Formatting/gh-pages?filepath=literate.ipynb)
232-
233225
## Generating Script outputs
234226

235227
To generate .fsx output for each script and markdown file, add a `_template.fsx`, usually empty. Substitutions are

docs/evaluation.fsx

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,10 @@ index: 8
2222
#endif // IPYNB
2323

2424
(**
25-
[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;
26-
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)&emsp;
27-
[![Notebook](img/badge-notebook.svg)]({{root}}/{{fsdocs-source-basename}}.ipynb)
25+
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)
2826
2927
# Embedding script output
3028
31-
3229
For literate F# scripts, you may embed the result of running the script as part of the literate output.
3330
This is a feature of the functions discussed in [literate programming](literate.html) and
3431
it is implemented using the [F# Compiler service](http://fsharp.github.io/FSharp.Compiler.Service/).
@@ -51,7 +48,6 @@ To include the a formatted value use ``include-it``:
5148
5249
(*** include-it ***)
5350
54-
5551
To include the meta output of F# Interactive processing such as type signatures use `(*** include-fsi-output ***)`:
5652
5753
let test = 40 + 3

docs/img/badge-binder.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/img/badge-notebook.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/literate.fsx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,8 @@ index: 4
2121
#r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
2222
#endif // IPYNB
2323

24-
2524
(**
26-
[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;
27-
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)&emsp;
28-
[![Notebook](img/badge-notebook.svg)]({{root}}/{{fsdocs-source-basename}}.ipynb)
25+
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)
2926
3027
Literate Scripts
3128
================

docs/markdown.fsx

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,8 @@ index: 2
1818
#r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
1919
#endif // IPYNB
2020

21-
2221
(**
23-
[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;
24-
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)&emsp;
25-
[![Notebook](img/badge-notebook.svg)]({{root}}/{{fsdocs-source-basename}}.ipynb)
22+
[![Script](img/badge-script.svg)]({{root}}/{{fsdocs-source-basename}}.fsx)
2623
2724
Markdown parser
2825
==============================
@@ -37,7 +34,6 @@ First, we need to load the assembly and open the necessary namespaces:
3734
open FSharp.Formatting.Markdown
3835
open FSharp.Formatting.Common
3936

40-
4137
(**
4238
Parsing documents
4339
-----------------

0 commit comments

Comments
 (0)