alan-turing-institute / PDSampler.jl

Piecewise Deterministic Sampler library (Bouncy particle sampler, Zig Zag sampler, ...)
Other
33 stars 8 forks source link

investigate documentation in julia from docstring #4

Closed tlienart closed 7 years ago

tlienart commented 7 years ago
tlienart commented 7 years ago

bases working and included in CI (https://alan-turing-institute.github.io/PDMP.jl/latest/)

now we need to list things in sensible way following the syntax explained in https://juliadocs.github.io/Documenter.jl/stable/man/guide.html#Package-Guide-1

I believe the structure goes as follows

docs
| --- build (*)
| --- site (*)
| --- src
       | --- index.md
       | ...     

where the (*) folders should not be modified / committed etc (all this is handled by Travis). index.md is the landing page, and ... could be any sort of reasonable sorting of "pages" we want to be using.