Document how to build docs locally

[antoine-levitt]

trafficstars

I was trying to tell @LaurentVidal95 how to add an example and got lost trying to understand make.jl. Also we can't specify the order of the examples, or perhaps divide them into subcategories. I think we've been trying to be too clever here: let's just have a maual, explicit list of examples

[mfherbst]

But we have, right in this file: https://github.com/JuliaMolSim/DFTK.jl/blob/master/docs/src/index.md. I'm not sure what the issue actually is. Maybe lacking documentation that is fair, but could you describe more precisely what you find too complicated?

[antoine-levitt]

Ah, indeed, I remember now. So basically it's just writing a .jl file in the examples dir (which gets built by literate into a .md file in the build dir), and adding it to the index.md file. Laurent's question was about how do you get the docs to build locally (and in particular only build one file). We should just add a comment about that at the top of the make.jl then.

[mfherbst]

I wanted and you said it was "obviously" just julia make.jl :smile:. Also there is the README which tells you to run the build script :smile:.

Actually I don't think this should be a comment. We should have a "developer" or "contributer" section in the manual with such things.

[antoine-levitt]

Well OK I should have remembered to read the README :-) So maybe we should just expand a bit on that. Let's see if Laurent manages to figure it out, it'll be a good test for if it's sufficiently clear or not :D

[LaurentVidal95]

I am doing that just now I'll keep you informed ;)

EDIT : ok for now it seems I have an error with makedocs !