FSharp.Compiler.Service documentation generation
Contributing to Library Content
To improve the content of the FSharp.Compiler.Service library documentation, contribute to the XML
/// documentation in the
signature files (
*.fsi) in the FSharp.Compiler.Service implementation.
Fork and clone https://github.com/dotnet/fsharp locally, see below
Once accepted your work will be published through a rebuild here. A rebuild is triggered daily at 17:30 UTC or you can trigger it yourself by submitting a dummy change.
The docs are generated by using
fsdocs tool from FSharp.Formatting.
Eventually the build will just be
dotnet tool restore dotnet restore FSharp.Compiler.Service dotnet fsdocs build
For now, we make a fresh build of FSharp.Compiler.Service.
(start in fsharp-conpiler-docs) dotnet restore fsharp-conpiler-docs (make fsharp-conpiler-docs/fsharp) git clone https://github.com/dotnet/fsharp --depth 1 -b main (build fsharp-conpiler-docs) pushd fsharp .\build -noVisualStudio popd
Then do iterative development using:
(from fsharp-conpiler-docs) dotnet fsdocs watch --sourcefolder fsharp --input fsharp/docs
This repo is published via GitHub Actions. On each push to main, the docs are built, and the outputs (which are written to the
output directory by fsdocs) are pushed to the
gh-pages branch. This repo is configured to host using GitHub Pages from this branch.