Sorry, it's hidden in a branch (again, a work in progress): * https://github.com/tshort/Sims.jl/tree/mkdocs
Here is the documentation directory with the static markdown files and the markdown files generated from Docile: * https://github.com/tshort/Sims.jl/tree/mkdocs/docs Compare the input and output for one of the source files: * https://github.com/tshort/Sims.jl/blob/mkdocs/examples/lib/electrical.jl: * https://tshort.github.io/Sims.jl/examples/lib/#electrical On Sat, Jan 10, 2015 at 12:06 PM, Petr Krysl <[email protected]> wrote: > Hi, > > I had a look at your package: very nice indeed! It is not clear to me > where the actual documentation is though. I followed some links to source > code and there was no documentation in there… > > Petr > > On Saturday, January 10, 2015 at 8:35:24 AM UTC-8, tshort wrote: >> >> Docile.jl works great. With Lexicon (or base Julia 0.4dev), you get nice >> REPL help. >> >> Mkdocs (http://mkdocs.org) works great for taking Markdown from Docile >> output along with other Markdown files to make online documentation. Mkdocs >> is super easy and works great with Github Pages. It also works with >> readthedocs (but I haven't tried that). >> >> Here is an example of package documentation developed with Docile and >> Mkdocs (still a work in progress): >> >> https://tshort.github.io/Sims.jl/ >> >> >> >> On Fri, Jan 9, 2015 at 3:41 AM, Ján Dolinský <[email protected]> >> wrote: >> >>> Hi, >>> >>> I would like to know how to write a help (comment) text e.g. for a >>> module function so that once module is loaded it is displayed if in REPL >>> help mode. >>> E.g. for "sum" function >>> help?>sum >>> displays brief help text for "sum" >>> >>> Thanks, >>> Jan >>> >> >>
