Update the documentation howto index page and group docs into 3 logical sections #119366
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
bedevere-app
bot
added
docs
nedbat
reviewed
May 21, 2024
nedbat
reviewed
May 21, 2024
|
Would it make sense to distinguish between Python howto’s and C (extension) howto’s? |
Co-authored-by: Ned Batchelder <[email protected]>
Sure! Let me take a look after I am home. |
Eric Mathes and I were discussing this so he gets a bunch of credit for inspiration. Oh, and thanks for the rST tip and suggestion. Too much time with Markdown 😉 |
rhettinger
approved these changes
May 23, 2024
encukou
reviewed
May 30, 2024
|
@willingc Is there more review/discussion you're waiting for, or should I merge this? |
encukou
approved these changes
Jun 17, 2024
|
I'll merge. |
encukou
added
needs backport to 3.12
|
Sorry, @willingc and @encukou, I could not cleanly backport this to |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jun 17, 2024
…al sections (pythonGH-119366) (cherry picked from commit a26d27e) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Ned Batchelder <[email protected]>
|
GH-120646 is a backport of this pull request to the 3.13 branch. |
encukou
added a commit
to encukou/cpython
that referenced
this pull request
Jun 18, 2024
This was referenced Jun 18, 2024
encukou
added a commit
that referenced
this pull request
Jun 19, 2024
encukou
added a commit
to miss-islington/cpython
that referenced
this pull request
Jun 19, 2024
encukou
pushed a commit
that referenced
this pull request
Jun 20, 2024
…3 logical sections (GH-119366, GH-120703) (GH-120646) Update the documentation howto index page and group docs into 3 logical sections (GH-119366) (cherry picked from commit a26d27e) Includes a follow-up fix to properly merge GH-119877: * Add a link to free-threading HOWTO to the index (GH-120703) (cherry picked from commit 45d5cab) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Ned Batchelder <[email protected]>
mrahtz
pushed a commit
to mrahtz/cpython
that referenced
this pull request
Jun 30, 2024
…al sections (pythonGH-119366) Co-authored-by: Ned Batchelder <[email protected]>
mrahtz
pushed a commit
to mrahtz/cpython
that referenced
this pull request
Jun 30, 2024
noahbkim
pushed a commit
to hudson-trading/cpython
that referenced
this pull request
Jul 11, 2024
…al sections (pythonGH-119366) Co-authored-by: Ned Batchelder <[email protected]>
noahbkim
pushed a commit
to hudson-trading/cpython
that referenced
this pull request
Jul 11, 2024
estyxx
pushed a commit
to estyxx/cpython
that referenced
this pull request
Jul 17, 2024
…al sections (pythonGH-119366) Co-authored-by: Ned Batchelder <[email protected]>
estyxx
pushed a commit
to estyxx/cpython
that referenced
this pull request
Jul 17, 2024
hugovk
pushed a commit
to hugovk/cpython
that referenced
this pull request
Dec 11, 2024
…3 logical sections (pythonGH-119366) (cherry picked from commit a26d27e) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Ned Batchelder <[email protected]>
|
GH-127811 is a backport of this pull request to the 3.12 branch. |
hugovk
added a commit
that referenced
this pull request
Dec 11, 2024
…3 logical sections (GH-119366) (#127811) (cherry picked from commit a26d27e) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Ned Batchelder <[email protected]>
|
Backported to 3.12 to fix #127578. |
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.
During PyCon discussions, a number of authors and educators mentioned simplifying the display of information on the HOWTO landing page. This PR groups the HOWTO documents into 3 sections:
This PR should help improve docs usability. The sections are sorted alphabetically roughly by the module or important topic.
Screenshot below
📚 Documentation preview 📚: https://cpython-previews--119366.org.readthedocs.build/en/119366/howto/index.html