Generate API docs

[dungpa]

FSharp.Formatting 2.3.4-beta finally is able to generate API docs for FSharp.Compiler.Service.

I adjusted the build script to generate API docs for public members and automatically create GitHub links to all functions and members.
It takes 200 seconds in my machine (not bad).

Documentation needs some love, but once the first version goes live; it is much easier to improve.

[7sharp9]

200 seconds? That seems like a long time...

[dungpa]

It's interplay of Razor, templating and a huge API space of FSharp.Compiler.Service. There's certainly a lot of rooms for improvements.

[7sharp9]

Yeah I would love an alternative to razor, the C# compilation seems to take an age.

[tpetricek]

Nice! Razor is not perfect and having an alternative would be nice (@7sharp9 feel free to submit a pull request!) That said, you only need to build the documentation when releasing a new version, so I think 200seconds is fine. Also, this actually utilizes multi-core CPU, so it might be faster if you have more CPUs!

[7sharp9]

Ive been using it for generating blog posts in ‘real-time’ unfortunately.

On 20 Jan 2014, at 18:26, Tomas Petricek [email protected] wrote:

Nice! Razor is not perfect and having an alternative would be nice (@7sharp9 feel free to submit a pull request!) That said, you only need to build the documentation when releasing a new version, so I think 200seconds is fine. Also, this actually utilizes multi-core CPU, so it might be faster if you have more CPUs!

—
Reply to this email directly or view it on GitHub.

[tpetricek]

I generated & published the documentation. Looks quite nice - for example, see the InteractiveChecker type: http://fsharp.github.io/FSharp.Compiler.Service/reference/microsoft-fsharp-compiler-sourcecodeservices-interactivechecker.html

It took about 10 minutes on my poor laptop, which is a bit long. The main problem is that RazorEngine re-compiles the templates every time it is run (I think), so this should be fixable just by pre-compiling the templates and calling them repeatedly with different Model objects.

[7sharp9]

I found that the Razor.Core in literate doesn't work for me, I get a missing method exception.

I had to use a newer verson of Razor.Core with a patch:
https://github.com/7sharp9/RazorEngine/commit/2098fb0264839b09601f5b2bf335eafa567d352e