ClarityNLP uses Sphinx Documentation. Once installed, the ClarityNLP documentation site can be ran locally via Sphinx Autobuild or via make. Documentation can use .rst (ReStructured Text) or '.md (Markdown) file types.

ClarityNLP Documentation is auto-deployed via ReadTheDocs. ClarityNLP has two main branches auto-deployed:

• development
• master (alternate link)

You may need to install the custom theme as well to run the project locally.

pip install sphinx_rtd_theme

To run locally, and after installing Sphinx Autobuild (see above), from ClarityNLP root directory, run:

sphinx-autobuild docs docs/_build/html