Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

Compiling spyrmsd's Documentation

The docs for this project are built with Sphinx.

Installation

Ensure that Sphinx and the ReadTheDocs theme are installed:

conda install sphinx sphinx_rtd_theme

Documentation

Automatic API Documentation

Create API documentation automatically with sphinx-apidoc:

sphinx-apidoc -f -M -e  -T -o source/api ../gninatorch

Build Documentation

Use the Makefile to compile static HTML pages:

make html

Visualize Documentation

The compiled docs will be in the build directory and can be viewed by opening index.html (which may itself be inside a directory called html/ depending on what version of Sphinx is installed).