Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Note minimum requirements for Sphinx#216

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
AA-Turner merged 3 commits intopython:mainfromAA-Turner:sphinx-reqs
Jan 28, 2025

Conversation

@AA-Turner
Copy link
Member

@AA-TurnerAA-Turner commentedJan 27, 2025
edited by github-actionsbot
Loading

We implicitly support theversions 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/

#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 inpyproject.toml?

That is:

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

Copy link
MemberAuthor

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 thestable 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 reacted with thumbs up emoji
@AA-TurnerAA-Turner merged commit01d5bcf intopython:mainJan 28, 2025
14 checks passed
@AA-TurnerAA-Turner deleted the sphinx-reqs branchJanuary 28, 2025 01:40
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@hugovkhugovkhugovk approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@AA-Turner@hugovk

[8]ページ先頭

©2009-2025 Movatter.jp