Fix readthedocs builds, update copyright year & Writing Docs page #142
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
Add .readthedocs.yaml to fix rtd-builds and add docs requirements (replacing sphinx_requirements.txt) via extras section in setup.py. This ignores our Jinja2 version fixation! Let's see if that works!
and some wording adaptions.
we install via setuptools "extras_require" now.
|
@prcutler @alifhughes @AnssiAhola this is just an FYI, I don't need a real review! I verified everything and think it's fine. I'll doublecheck and merge tomorrow or so. |
|
There is one typo in the "Build the Documentation "section: It says:
Should be: 'We recommend' Otherwise looks good to me! |
on Writing Docs page.
JOJ0
changed the title
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.
Fixes #136
Add .readthedocs.yaml to fix rtd-builds and add docs requirements (replacing sphinx_requirements.txt) via extras section in setup.py.
This ignores our Jinja2 version fixation! Let's see if that works!
Also some wording changes in our "Writing docs section".
In enabled this PR's branch to review the changes and the succesful build: https://python3-discogs-client.readthedocs.io/en/fix_readthedocs/writing_docs.html
Build on RTD seems to be fine. Sphinx autodoc worked as well (that was IIRC the reason we had Jinja2 fixated to a specific version in the now deleted sphinx_requirements.txt.)