Generate module index #900
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Populate the module index by setting up Sphinx to automatically run sphinx-apidoc for every build. Also, move readthedocs dependencies under docs/ and make prune-environment.py automatically generate the environment-rtd.yaml file whenever we run repin.sh.
Codecov Report
@@ Coverage Diff @@
## master #900 +/- ##
=======================================
Coverage 50.41% 50.41%
=======================================
Files 34 34
Lines 3372 3372
=======================================
Hits 1700 1700
Misses 1672 1672 Continue to review full report at Codecov.
|
boolean5
commented
Apr 26, 2021
vringar
approved these changes
Apr 26, 2021
Zaxeli
pushed a commit
to Zaxeli/OpenWPM
that referenced
this pull request
Aug 10, 2021
* Fix documentation module index Populate the module index by setting up Sphinx to automatically run sphinx-apidoc for every build. Also, move readthedocs dependencies under docs/ and make prune-environment.py automatically generate the environment-rtd.yaml file whenever we run repin.sh. * Fix black and mypy errors
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 fixes #895 by setting up Sphinx to automatically run
sphinx-apidocfor every build, using the workaround suggested in readthedocs/readthedocs.org#1139 (comment). Also, it moves readthedocs dependencies underdocs/and makesprune-environment.pyautomatically generate theenvironment-rtd.yamlfile whenever we runrepin.sh, so that we don't have to remember to keep it in sync with the mainenvironment.yamlmanually.Note that we have to install all dependencies and not just the ones required to build the docs after all, as
autodocimports the modules in order to extract the docstrings. Not installing all dependencies would result in import errors.@vringar, could you please point me to where you found the conda version that readthedocs uses, that you mentioned in #890 (comment)? I'd like to open an issue to revert our workaround of keeping
geckodriverpinned to version0.26.0when readthedocs updates its conda version.