search

joalla / discogs_client

Continuation of the "Official Python Client for the Discogs API"
https://python3-discogs-client.readthedocs.io
Other
310 stars 50 forks source link

Fix readthedocs builds, update copyright year & Writing Docs page #142

Closed JOJ0 closed 10 months ago

JOJ0 commented 10 months ago

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.)

JOJ0 commented 10 months ago

@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.

prcutler commented 10 months ago

There is one typo in the "Build the Documentation "section:

It says:

We reommend using Python 3.9 or Python 3.11 for building the documentation.

Should be: 'We recommend'

Otherwise looks good to me!