Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Source Documentation

We use Sphinx for source documentation. Current documentation is built automatically and available from our github.io site.

You also may generate the documentation via SCons from the openvisualizer directory, with the 'docs' target. All documentation templates (.rst files) are stored in the openvisualizer/docs directory.

The pythonhosted site includes an excellent page on Sphinx formatting. See the "Full Code Example" section at the bottom of the page for docstring tags.

 

  • No labels