Reword about.rst to not limit Sphinx
#128325
Merged
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
bedevere-app
bot
added
docs
picnixz
reviewed
Dec 29, 2024
hugovk
reviewed
Dec 29, 2024
AA-Turner
approved these changes
Dec 29, 2024
Oh, I actually understood the document as being the input and not the output (we process a document to produce something out of it). But I like your suggested formulation (it's good to say that it's externally managed). |
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
picnixz
approved these changes
Dec 31, 2024
hugovk
added
needs backport to 3.12
|
Thanks @StanFromIreland for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13. |
|
Thanks @StanFromIreland for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Dec 31, 2024
(cherry picked from commit c5438fd) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Dec 31, 2024
(cherry picked from commit c5438fd) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
|
GH-128382 is a backport of this pull request to the 3.13 branch. |
|
GH-128383 is a backport of this pull request to the 3.12 branch. |
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.
Currently the documentation makes it sound like Sphinx is restricted for CPython documentation which is misleading as it is not.
I also propose a more formal title, which is more consistent with
about.rstasdocumentationis preferred overdocuments.Finally a small change,
writeris replaced byauthorwhich again is also more consistent with the documentation overall as people are elsewhere referred to as "authors".The page is linked as
About the Documentationin the index.📚 Documentation preview 📚: https://cpython-previews--128325.org.readthedocs.build/