Fix for ReadtheDocs build #1061
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
The ReadtheDocs build is currently failing because it is unable to find sphinx_copybutton. This occurs because ReadtheDocs by default will only install dependencies of the default requirements.txt at the root. The fix needs to install the sphinx_copybutton package found in doc/requirements.txt. ReadtheDocsv2 now provides a better configuration using a YAML file [1] instead of just the UI and its limited options. This change adds the new .readthedocs.yaml file that allows us to control what dependencies are installed via two requirements.txt files, one in root and one in doc/. [1] https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os Signed-off-by: Eric Brown <eric_wade_brown@yahoo.com>
|
Link to the latest failed build of the docs: https://readthedocs.org/projects/bandit/builds/21971393/ |
sigmavirus24
approved these changes
Sep 21, 2023
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.
The ReadtheDocs build is currently failing because it is unable to find sphinx_copybutton. This occurs because ReadtheDocs by default will only install dependencies of the default requirements.txt at the root.
The fix needs to install the sphinx_copybutton package found in doc/requirements.txt. ReadtheDocsv2 now provides a better configuration using a YAML file [1] instead of just the UI and its limited options.
This change adds the new .readthedocs.yaml file that allows us to control what dependencies are installed via two requirements.txt files, one in root and one in doc/.
[1] https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os