Oh okay. So you just make docstrings (which can have LaTeX and support REPL help) and then Documenter.jl can convert them into Markdown files which mkdocs can convert into HTML documentation (with which I can choose a different theme)? I think I got this now.
On Wednesday, May 11, 2016 at 9:33:57 AM UTC-7, Tommy Hofmann wrote: > > Do you also want to support the repl help system? By this I mean, do you > want to do the following also for your custom functions/types? > > help?> BigInt > search: BigInt disable_sigint reenable_sigint set_bigfloat_precision > > BigInt(x) > > Create an arbitrary precision integer. x may be an Int (or anything that > can > be converted to an Int). The usual mathematical operators are defined for > this type, and results are promoted to a BigInt. > > Instances can be constructed from strings via parse, or using the big > string > literal. > > help?> gcd > search: gcd gcdx gc_disable significand > > gcd(x,y) > > Greatest common (positive) divisor (or zero if x and y are both zero). > > These are coming from the docstrings attached to the types/function (see > http://docs.julialang.org/en/release-0.4/manual/documentation/). As far > as I know they have to be written in Markdown. I do not know how well > Sphinx and Markdown work together (Sphinx usually uses files in > reStructuredText (rst) format). > > On Wednesday, May 11, 2016 at 6:10:06 PM UTC+2, Chris Rackauckas wrote: >> >> Thanks for the link. I'll look into using Documenter.jl + mkdocs. Is >> there anyway that the format can match something like Sphinx/MakeTheDocs (I >> don't really know what that is)? I like that look much better; the font >> from the Documenter.jl examples is wonky and hard to read. >> >> On Wednesday, May 11, 2016 at 9:01:48 AM UTC-7, Tommy Hofmann wrote: >>> >>> What about this post? >>> >>> https://groups.google.com/forum/#!searchin/julia-users/documentation/julia-users/q7rwopVQHV4/o-mDXpqhAwAJ >>> Note that instead of Lexicon.jl one should use Documenter.jl but the >>> workflow is similar. >>> >>> Documenter.jl provides an easy way to combine docstrings and manually >>> written Markdown files. At the end of the day one gets mkdocs >>> documentations, which can be deployed to readthedocs, but you can also >>> produce a pdf using https://github.com/jgrassler/mkdocs-pandoc. >>> >>> Documenter.jl itself has nothing to do with LaTeX or not. No one >>> prevents you from using LaTeX in your dostrings or Markdown files. >>> >>> >>> On Wednesday, May 11, 2016 at 5:20:36 PM UTC+2, Chris Rackauckas wrote: >>>> >>>> Forgot to mentioned that LaTeX is a requirement. I don't see any LaTeX >>>> in Documenter.jl >>>> >>>> On Wednesday, May 11, 2016 at 7:42:34 AM UTC-7, Kristoffer Carlsson >>>> wrote: >>>>> >>>>> https://github.com/MichaelHatherly/Documenter.jl with its >>>>> documentation http://michaelhatherly.github.io/Documenter.jl/latest/ >>>>> is good imo. >>>>> >>>>> You can look at packages that are using Documenter here: >>>>> http://michaelhatherly.github.io/Documenter.jl/latest/man/examples/ >>>>> >>>>> On Wednesday, May 11, 2016 at 4:04:58 PM UTC+2, Chris Rackauckas wrote: >>>>>> >>>>>> Hi, >>>>>> I was wondering if there's any documentation/tutorials for >>>>>> generating documentation for Julia packages. I would like to make one of >>>>>> those Read the Docs things but I don't know where to start (or if that's >>>>>> still the preferred method) and a quick Google / Julia-users search >>>>>> didn't >>>>>> hit a result. >>>>>> >>>>>
