diffsharp.github.io/README.fsx at master · DiffSharp/diffsharp.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
(**
# Running notebooks in MyBinder

The `Dockerfile` and `NuGet.config` allow us to run generated notebooks in [MyBinder](https://mybinder.org)

* `master` branch of diffsharp/diffsharp.github.io:  [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/diffsharp/diffsharp.github.io/master)

# Generating docs

To iterate on docs (requires evaluation off since DLLs get locked)

    dotnet fsdocs watch

To use a local build of FSharp.Formatting:

       git clone https://github.com/fsprojects/FSharp.Formatting  ../FSharp.Formatting
       pushd ..\FSharp.Formatting
       .\build
       popd

Then:

       ..\FSharp.Formatting\src\FSharp.Formatting.CommandTool\bin\Debug\net6.0\fsdocs.exe watch
       ..\FSharp.Formatting\src\FSharp.Formatting.CommandTool\bin\Debug\net6.0\fsdocs.exe build --clean --eval

## Generated Notebooks

Notebooks are generated for all .md and .fsx files under docs as part of the build.

* Dockerfile - see [https://github.com/dotnet/interactive/blob/master/docs/CreateBinder.md](https://github.com/dotnet/interactive/blob/master/docs/CreateBinder.md)


* NuGet.config - likewise


See MyBinder for creating URLs

*)