Here is an example of documentation for a package I maintain: https://tshort.github.io/Sims.jl/
Here are examples of docstrings: https://github.com/tshort/Sims.jl/blob/master/src/sim.jl#L1-L96 Here is the config file for Mkdocs: https://github.com/tshort/Sims.jl/blob/master/mkdocs.yml Here is a Julia script that uses the Lexicon package to build the API documentation from the docstrings: https://github.com/tshort/Sims.jl/blob/master/docs/build.jl Here are other packages that use Mkdocs: https://www.google.com/search?q=mkdocs.yml+jl+site:github.com&ie=utf-8&oe=utf-8 On Thu, Mar 12, 2015 at 10:28 AM, Ismael VC <[email protected]> wrote: > tshort, could you provide us an example please? > > El jueves, 12 de marzo de 2015, 4:59:14 (UTC-6), tshort escribió: >> >> The Lexicon package works well for me along with Mkdocs. >> On Mar 12, 2015 6:03 AM, "Ján Adamčák" <[email protected]> wrote: >> >>> Hi guys, >>> >>> Can I ask you for something like best practice with auto doc tools for >>> parsing Julia code? I try use Doxygen and Sphinx, but I think this is not >>> good solutions in this time&version(0.3.6). And/Or some tool for generate >>> UML diagrams from julia code? >>> >>> Thanks. >>> >>> P.S.: >>> My idea with this thread is generate something like big manual of >>> knowlege how to use auto doc tools in Julia. >>> >>
