Closed dpinte closed 3 years ago
The ReadTheDocs build is now passing, but not generating the autoapi modules - I think this could be dealt with either on the readthedocs settings, or by including a yml configuration file in this repository.
Looking at https://sphinx-rtd-tutorial.readthedocs.io/en/latest/sphinx-config.html, it seems that a requirements.txt
document (or equivalent) is needed to kick start the autodoc-api:
"If we didn’t have the requirements file, then ReadTheDocs would fail to run autodoc in order to generate our documentation from the comments in our source code. In other words, when building our documentation, RTD calls a pip install -r requirements.txt
, which installs any requirements in a virtual environment, which is then where sphinx-apidoc is run."
From https://readthedocs.org/projects/force-bdss/builds/11021492/