Add required .readthedocs.yaml, conf.py and set sphinx_rtd_theme
#2049
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
RTD no longer automatically generates config files. The `.readthedocs.yaml` is now required: https://blog.readthedocs.com/migrate-configuration-v2/ The `conf.py` for Sphinx is also required: https://blog.readthedocs.com/doctool-without-configuration-file/ - The previously automatically generated `conf.py` contained `sphinx_rtd_theme` -> in order to keep it we have to set it and add it as a requirement. - The version field in `conf.py.in` remains uncofigured but I don't think it is a problem because it doesn't shows up in the html docs.
|
Thanks! |
jan-kolarik
merged commit 259e4c9
into
rpm-software-management:master
1 of 4 checks passed
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.
RTD no longer automatically generates config files.
The
.readthedocs.yamlis now required: https://blog.readthedocs.com/migrate-configuration-v2/The
conf.pyfor Sphinx is also required: https://blog.readthedocs.com/doctool-without-configuration-file/conf.pycontainedsphinx_rtd_theme-> in order to keep it we have to set it and add it as a requirement.conf.py.inremains uncofigured but I don't think it is a problem because it doesn't shows up in the html docs.This fixes the currently failing dnf doc building.