Giter Club home page Giter Club logo

fsharp-compiler-docs's Introduction

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.

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

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.

fsharp-compiler-docs's People

Contributors

7sharp9 avatar auduchinok avatar aviavni avatar baronfel avatar brettfo avatar cartermp avatar cloudroutine avatar ctaggart avatar dotnet-bot avatar dotnet-maestro[bot] avatar dsyme avatar dungpa avatar eiriktsarpalis avatar enricosada avatar forki avatar fsgit avatar funnelweb avatar jackmott avatar kevinransom avatar latkin avatar liboz avatar majocha avatar ncave avatar patrickmcdonald avatar quasilord avatar rneatherway avatar smoothdeveloper avatar tihan avatar vasily-kirichenko avatar vzarytovskii avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.