Skip to content

Files

Latest commit

 

History

History

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

Building the docs

It is really easy. You'll need sphinx (the python one).

Use make

Just type make:

% make

Look in the Makefile for more targets.

Manually

  1. Generate the code.rst file so that Sphinx will pull in our docstrings:

    % ./generate_autodoc_index.sh > source/code.rst
    
  2. Run sphinx_build:

    % sphinx-build -b html source build/html
    

The docs have been built

Check out the build directory to find them. Yay!