force-h2020 / force-bdss

Business Decision System general interface
BSD 2-Clause "Simplified" License
2 stars 2 forks source link

reathedocs fails at building the docs #350

Closed dpinte closed 3 years ago

dpinte commented 4 years ago

From https://readthedocs.org/projects/force-bdss/builds/11021492/

ERROR: Could not open requirements file: [Errno 2] No such file or directory: 'requirements/doc_requirements.txt'
flongford commented 4 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."