Note minimum requirements for Sphinx - #216
AA-Turner merged 3 commits into
Conversation
Sorry, something went wrong.
| # 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. |
There was a problem hiding this comment.
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",
]
Sorry, something went wrong.
There was a problem hiding this comment.
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.
Sorry, something went wrong.
There was a problem hiding this comment.
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.
Sorry, something went wrong.
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/