Building the Docs

Although documentation for the OpenFF QCSubmit is readily available online, it is sometimes useful to build a local version such as when

  • developing new pages which you wish to preview without having to wait for ReadTheDocs to finish building.

  • debugging errors which occur when building on ReadTheDocs.

In these cases, the docs can be built locally by doing the following:

git clone https://github.com/openforcefield/openff-qcsubmit.git
cd openff-qcsubmit/docs
conda env create --name openff-qcsubmit-docs --file environment.yaml
conda activate openff-qcsubmit-docs
rm -rf api && make clean && make html

The above will yield a new directory named _build which will contain the built html files which can be viewed in your local browser.