Add lightweight comments to conf.py and update docs readme #126100
Merged
Conversation
This file contains hidden or 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
willingc
added
docs
hugovk
added
needs backport to 3.12
Co-authored-by: Hugo van Kemenade <[email protected]>
AA-Turner
reviewed
Oct 29, 2024
Co-authored-by: Adam Turner <[email protected]>
AA-Turner
reviewed
Oct 29, 2024
Co-authored-by: Adam Turner <[email protected]>
AA-Turner
approved these changes
Oct 29, 2024
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
|
Thanks for the review @AA-Turner and @hugovk |
|
Thanks @willingc for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Oct 29, 2024
…126100) * Update contributing contact info in readme * Add lightweight comments to improve docs workflow understanding * Apply code review suggestions from @hugovk Co-authored-by: Hugo van Kemenade <[email protected]> * Add code review suggestion from @AA-Turner Co-authored-by: Adam Turner <[email protected]> * Update Doc/conf.py Co-authored-by: Adam Turner <[email protected]> * Update Doc/conf.py Co-authored-by: Adam Turner <[email protected]> * Update Doc/conf.py Co-authored-by: Adam Turner <[email protected]> --------- (cherry picked from commit 9effa0f) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Adam Turner <[email protected]>
|
GH-126134 is a backport of this pull request to the 3.13 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Oct 29, 2024
…126100) * Update contributing contact info in readme * Add lightweight comments to improve docs workflow understanding * Apply code review suggestions from @hugovk Co-authored-by: Hugo van Kemenade <[email protected]> * Add code review suggestion from @AA-Turner Co-authored-by: Adam Turner <[email protected]> * Update Doc/conf.py Co-authored-by: Adam Turner <[email protected]> * Update Doc/conf.py Co-authored-by: Adam Turner <[email protected]> * Update Doc/conf.py Co-authored-by: Adam Turner <[email protected]> --------- (cherry picked from commit 9effa0f) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Adam Turner <[email protected]>
|
GH-126135 is a backport of this pull request to the 3.12 branch. |
willingc
added a commit
that referenced
this pull request
Oct 29, 2024
…-126100) (#126134) Add lightweight comments to conf.py and update docs readme (GH-126100) * Update contributing contact info in readme * Add lightweight comments to improve docs workflow understanding * Apply code review suggestions from @hugovk * Add code review suggestion from @AA-Turner * Update Doc/conf.py * Update Doc/conf.py * Update Doc/conf.py --------- (cherry picked from commit 9effa0f) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Adam Turner <[email protected]>
willingc
added a commit
that referenced
this pull request
Oct 29, 2024
…-126100) (#126135) Add lightweight comments to conf.py and update docs readme (GH-126100) * Update contributing contact info in readme * Add lightweight comments to improve docs workflow understanding * Apply code review suggestions from @hugovk * Add code review suggestion from @AA-Turner * Update Doc/conf.py * Update Doc/conf.py * Update Doc/conf.py --------- (cherry picked from commit 9effa0f) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Adam Turner <[email protected]>
picnixz
pushed a commit
to picnixz/cpython
that referenced
this pull request
Dec 8, 2024
…126100) * Update contributing contact info in readme * Add lightweight comments to improve docs workflow understanding * Apply code review suggestions from @hugovk Co-authored-by: Hugo van Kemenade <[email protected]> * Add code review suggestion from @AA-Turner Co-authored-by: Adam Turner <[email protected]> * Update Doc/conf.py Co-authored-by: Adam Turner <[email protected]> * Update Doc/conf.py Co-authored-by: Adam Turner <[email protected]> * Update Doc/conf.py Co-authored-by: Adam Turner <[email protected]> --------- Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Adam Turner <[email protected]>
ebonnal
pushed a commit
to ebonnal/cpython
that referenced
this pull request
Jan 12, 2025
…126100) * Update contributing contact info in readme * Add lightweight comments to improve docs workflow understanding * Apply code review suggestions from @hugovk Co-authored-by: Hugo van Kemenade <[email protected]> * Add code review suggestion from @AA-Turner Co-authored-by: Adam Turner <[email protected]> * Update Doc/conf.py Co-authored-by: Adam Turner <[email protected]> * Update Doc/conf.py Co-authored-by: Adam Turner <[email protected]> * Update Doc/conf.py Co-authored-by: Adam Turner <[email protected]> --------- Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Adam Turner <[email protected]>
merwok
reviewed
Oct 14, 2025
| # There are two options for replacing |today|: either, you set today to some | ||
| # non-false value, then it is used: | ||
| # There are two options for replacing |today|. Either, you set today to some | ||
| # non-false value and use it. |
There was a problem hiding this comment.
The second change is wrong, the previous text was correct: if you (editor of conf.py) set the variable to a non-falce value, then it will be used (by sphinx when generating pages)
|
(Note that this was merged with a long, unhelpful commit message because of github’s strange default of pre-filling and hiding the commit message with a concatenation of all commit messages in the branch. There is a repository (and organization?) setting to change this default. The browser extension Github Refined also avoids this.) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
conf.pyabout location of the Python docs theme and extensions📚 Documentation preview 📚: https://cpython-previews--126100.org.readthedocs.build/