Read The Docs#

To generate documentation, must be able to run autodoc on RTD build server. This involves importing the ultrafast module, which obviously fails as it depends on lots of Python packages which are not necessarily installed on the build server (e.g. SciPy). The way RTD gets round this is by allowing you to install your package on their build server using pip [1] [2]. In doing so, you can specify a pip requirements file which details any dependencies your package may have. These will then be installed first.

As such, to properly serve autodoc generated documentation on RTD must:

  1. Make package installable via pip, ensuring pip requirements file contains all dependencies

  2. Push package to GitHub

  3. Specify location of pip requirements file on RTD project settings

Did all this and finally got RTD working. Issue was that had to push to GitHub to test. As such, all tests went live. Now begin clean up operation:

  1. Backup successful install files

  2. Delete local feat/install branch:

    git branch -D feat/install

  3. Delete remote feat/install branch (via GitHub hopefully…)

  4. Paste successful install files (into new feat/install branch)

  5. Merge into dev, push and pretend nothing happened

  6. Reconfigure RTD to use dev branch once again