Fix API documentation generation #3029
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR fixes the RTD documentation generation and deployment by eliminating many formatting issues, some importing errors and warnings resulting from the docstring generation via apidoc.
The main issue I fixed was to remove many of the docs dependencies, since they can be mocked in the
conf.pyfile and that makes the docs generation process faster and lighter. I also fixed a couple of typos, and reviewed the installation instructions which looked to me to be outdated (please confirm).This is a big PR since it involves many files, but changes are all in docstrings, so should not have any effect on actual code. In addition to fixing warnings, I also went ahead and reviewed as many docstrings as I could to fix formatting, make them consistent and better looking for the generated documentation website. Docstrings are written in rst format, and some of them were written in a markdown flavor - this is something to be aware of in the future (see https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)
Tests
Documentation builds correctly (and quickly) locally.
Checklist
Before submitting this PR, please make sure (put X in square brackets):
gemini-reviewlabel.