Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Note minimum requirements for Sphinx #216

Merged
merged 3 commits into from
Jan 28, 2025
Merged

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Jan 27, 2025

We implicitly support the versions used in CPython. However, Python 3.9 uses a pinned version of this theme (python/cpython#115351), so we can explicitly document our minimum supported versions as those used in the Python 3.10 branch.

A


📚 Documentation preview 📚: https://python-docs-theme-previews--216.org.readthedocs.build/

@@ -1,6 +1,7 @@
# Python Docs Sphinx Theme

This is the theme for the Python documentation.
It requires Python 3.9 or newer and Sphinx 3.4 or newer.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In another project we noticed the Python version mentioned in docs said 3.6+, but in reality it's 3.9+ and we'd forgotten to update that three times!

To DRY, perhaps we don't need to document this in words, seeing as we have definitive metadata in pyproject.toml?

That is:

requires-python = ">=3.9"
...
dependencies = [
  "sphinx>=3.4",
]

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose I put it in the README to make it very clear -- perhaps we could replace it with a policy statement instead? I.e.:

"It supports all Sphinx versions required by the stable Python branches."

I'm not a huge fan of this wording, though -- it feels clunky.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, it's okay to leave this in the README if you like, at least it's the repo's first page and not some other "hidden"/forgotten docs page.

@AA-Turner AA-Turner merged commit 01d5bcf into python:main Jan 28, 2025
14 checks passed
@AA-Turner AA-Turner deleted the sphinx-reqs branch January 28, 2025 01:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants