-
Notifications
You must be signed in to change notification settings - Fork 5
Building Documentation
bdsmith147 edited this page Jul 8, 2021
·
5 revisions
Follow these steps when building the documentation:
- Navigate to
/docsin 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 withconda. - Enter
$ make cleanto remove the existing documentation. You will also need to delete thedocs/source/auto_examplesfolder by hand. - Enter
$ make html. All the lines should execute successfully. - Check on the build by opening the
/docs/_build/html/index.htmlfile and verifying that it looks ok. - Run the /preprocess.py file to generate the README.rst. This combines separate .rst files into a single file.
- Commit with
gitand push to the remote repository. You can verify on the GitHub page that it was pushed correctly and that the README displays properly. - 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.)