Documentation

Packages

The documentation for the feature interpretability module is made with sphinx.

Below is a list of sphinx extensions that are required to build the docs:

• sphinx.ext.autodoc

• sphinx.ext.coverage

• sphinx.ext.napoleon

• sphinx.ext.githubpages

Additionally, the sphinx-toolbox and sphinx-argparse packages are installed to provide additional functionality. They are included in the extensions list as follows:

• sphinx_toolbox.collapse

• sphinxarg.ext

These are all included in the ./docs/source/conf.py file.

Generating Docs

All of the files to make the sphinx documentation is found in ./docs/. Source code is found in ./docs/source/, while built .html files are found in ./docs/build/.

To generate the most up-to-date documetaion, run the following commands in the ./docs/ directory:

• make clean to remove existing build docs

• make html to create the new docs

• open ./docs/build/html/index.html to view rendered docs

Rendered documentation is also hosted on GitHub.