Skip to content

Building Documentation

bdsmith147 edited this page Jul 8, 2021 · 5 revisions

Follow these steps when building the documentation:

  1. Navigate to /docs in the command prompt. Make sure that you're in the base environment (e.g. "pytorch") that contains the sphinx_rtd_theme. If not, you can install it with conda.
  2. Enter $ make clean to remove the existing documentation. You will also need to delete the docs/source/auto_examples folder by hand.
  3. Enter $ make html. All the lines should execute successfully.
  4. Check on the build by opening the /docs/_build/html/index.html file and verifying that it looks ok.
  5. Run the /preprocess.py file to generate the README.rst. This combines separate .rst files into a single file.
  6. Commit with git and push to the remote repository. You can verify on the GitHub page that it was pushed correctly and that the README displays properly.
  7. Go to the ReadTheDocs page associated with this project and build the docs; this will take a while. (I don't have the webhook set up, so I have to do this manually.)

Clone this wiki locally