Use sphinxcontrib-apidoc extension for readthedocs builds #345
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.
This PR replaces the
run_apidoc
event handler with the sphinxcontrib-apidoc extension. It does pretty much the same thing, but it's a little more convenient. Feel free to close this PR if you don't find that useful, but personally it's saved me quite a few headaches.Notes:
apidoc_separate_modules
is equivalent to the-e
optionapidoc_module_dir
andapidoc_output_dir
are relative to the documentation source dir (/docs
)tox.ini
so local Sphinx builds will use the apidoc config inconf.py
instead of separately running thesphinx-apidoc
command.readthedocs.yml
to installdocs-requirements.txt
. If you already have that configured in your settings on readthedocs.org, that file can be removed.