Documentation

You can find documentation for our code and modules at our Read the Docs. For those planning to contribute to McFACTS documentation, there are a couple extra packages you’ll need to install.

Installing Sphinx

To install via pip, run:

$ pip install sphinx sphinx_rtd_theme sphinx-autoapi sphinx-automodapi

To install these packages into a conda environment, activate the conda environment you’re using for McFACTS, and run:

$ conda install sphinx sphinx_rtd_theme sphinx-autoapi sphinx-automodapi

To generate the documentation pages, run the following:

# Switch to the docs directory
$ cd docs

# Clean up any previously generated docs
$ make clean

# Generate the html version of the docs in ./docs/build/html
$ make html

Note

If you create a new documentation file, it must be added to the list in docs/source/index.rst.

Inputs and outputs are documented in IOdocumentation.txt.