-
Notifications
You must be signed in to change notification settings - Fork 30
Description
I ran sphinx locally and noticed it outputs several warnings and errors. I didn't search thoroughly, but there are at least these problems:
-
SystemsClientis missing from the API reference because the autoclass is using the wrong module name (specsinstead ofsystems). -
Several APIs, at least asset and test monitor, use the incorrect indentation for parameter and exception docstrings such that they don't render correctly. For example, this line needs to be intended one more time to indicate it's a continuation rather than a new parameter. It gets rendered poorly:
I couldn't find any useful feedback from the readthedocs build report to flag these. I was able to run it locally by:
python -m venv docs\.venv
docs\.venv\Scripts\activate
python -m pip install --upgrade pip setuptools
python -m pip install -r docs\requirements.txt
python -m sphinx docs outputI don't know what poetry run poe doctest is supposed to do, but it doesn't work these days.