https://github.com/fsharp/fsharp-compiler-docs

Doc build for FSharp.Compiler.Service
https://github.com/fsharp/fsharp-compiler-docs

Last synced: about 1 month ago
JSON representation

Doc build for FSharp.Compiler.Service

• Host: GitHub
• URL: https://github.com/fsharp/fsharp-compiler-docs
• Owner: fsharp
• License: mit
• Created: 2013-09-30T21:01:56.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2024-05-01T17:35:23.000Z (7 months ago)
• Last Synced: 2024-05-02T01:53:53.423Z (7 months ago)
• Homepage: https://fsharp.github.io/fsharp-compiler-docs
• Size: 216 MB
• Stars: 278
• Watchers: 39
• Forks: 123
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-fsharp - F# Compiler Services ★ 159 ⧗ 0 - The F# Compiler, F# Interactive scripting engine and F# editing services as a component library. [Apache 2.0] (Compilers)

README

        
# FSharp.Compiler.Service documentation generation

https://fsharp.github.io/fsharp-compiler-docs

## 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

* Contribute to [src/fsharp directory](https://github.com/dotnet/fsharp/tree/master/docs) and [src/fsharp directory](https://github.com/dotnet/fsharp/tree/master/src/fsharp) and submit work to  `main` branch of [dotnet/fsharp](https://github.com/dotnet/fsharp)

* 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.  

## Build steps

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-compiler-docs)

    dotnet restore FSharp.Compiler.Service

    dotnet tool restore

    (make fsharp-compiler-docs/fsharp)

    git clone https://github.com/dotnet/fsharp --depth 1 -b main

    (build fsharp-compiler-docs/fsharp) 

    pushd fsharp

    dotnet build src/Compiler/FSharp.Compiler.Service.fsproj /p:BUILDING_USING_DOTNET=true

    popd

Then do iterative development using:

    (from fsharp-compiler-docs)

    dotnet fsdocs watch --sourcefolder fsharp  --input fsharp/docs

## CI Pipeline

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.