Skip to content

Latest commit

 

History

History

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Julia Documentation README

Julia's documentation is written in reStructuredText, a good reference for which is the Documenting Python chapter of the Python Developer's Guide.

Building the documentation

The documentation is built using Sphinx and LaTeX. On ubuntu, you'll need the following packages installed:

python-sphinx
texlive
texlive-latex-extra

Then run

$ make helpdb.jl
$ make html
$ make latexpdf

File layout

conf.py             Sphinx configuration
helpdb.jl           REPL help database
sphinx/             Sphinx extensions and plugins
sphinx/jlhelp.py    Sphinx plugin to build helpdb.jl
stdlib/             Julia standard library documentation
_themes/            Sphinx html themes