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

Update the documentation howto index page and group docs into 3 logical sections#119366

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
encukou merged 5 commits intopython:mainfromwillingc:howto-order
Jun 17, 2024

Conversation

willingc
Copy link
Contributor

@willingcwillingc commentedMay 21, 2024•
edited by hugovk
Loading

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:

  • General
  • Advanced development
  • Debugging and profiling

This PR should help improve docs usability. The sections are sorted alphabetically roughly by the module or important topic.

Screenshot below

Screenshot 2024-05-21 at 5 24 26 PM

📚 Documentation preview 📚:https://cpython-previews--119366.org.readthedocs.build/en/119366/howto/index.html

encukou reacted with thumbs up emojimscuthbert reacted with hooray emoji
Copy link
Member

@nedbatnedbat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I love the re-org. I suggested a less duplicative way to make .rst links.

mscuthbert reacted with thumbs up emoji
@gvanrossum
Copy link
Member

Would it make sense to distinguish between Python howto’s and C (extension) howto’s?

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
@willingc
Copy link
ContributorAuthor

Would it make sense to distinguish between Python howto’s and C (extension) howto’s?

Sure! Let me take a look after I am home.

@willingc
Copy link
ContributorAuthor

willingc commentedMay 22, 2024•
edited
Loading

I love the re-org. I suggested a less duplicative way to make .rst links.

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 😉

Copy link
Member

@hugovkhugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

👍

And backport to 3.12?

@encukou
Copy link
Member

@willingc Is there more review/discussion you're waiting for, or should I merge this?

@encukou
Copy link
Member

I'll merge.

@encukouencukou merged commita26d27e intopython:mainJun 17, 2024
25 checks passed
@encukouencukou added needs backport to 3.12only security fixes needs backport to 3.13bugs and security fixes labelsJun 17, 2024
@miss-islington-app
Copy link

Thanks@willingc for the PR, and@encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Thanks@willingc for the PR, and@encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Sorry,@willingc and@encukou, I could not cleanly backport this to3.12 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker a26d27e7ee512cd822b7a7ba075171152779ffdd 3.12

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestJun 17, 2024
…al sections (pythonGH-119366)(cherry picked from commita26d27e)Co-authored-by: Carol Willing <carolcode@willingconsulting.com>Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
@bedevere-app
Copy link

GH-120646 is a backport of this pull request to the3.13 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.13bugs and security fixes labelJun 17, 2024
encukou added a commit to encukou/cpython that referenced this pull requestJun 18, 2024
encukou added a commit to miss-islington/cpython that referenced this pull requestJun 19, 2024
encukou pushed a commit that referenced this pull requestJun 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 commita26d27e)Includes a follow-up fix to properly mergeGH-119877:* Add a link to free-threading HOWTO to the index (GH-120703)  (cherry picked from commit45d5cab)Co-authored-by: Carol Willing <carolcode@willingconsulting.com>Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
mrahtz pushed a commit to mrahtz/cpython that referenced this pull requestJun 30, 2024
…al sections (pythonGH-119366)Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
noahbkim pushed a commit to hudson-trading/cpython that referenced this pull requestJul 11, 2024
…al sections (pythonGH-119366)Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
noahbkim pushed a commit to hudson-trading/cpython that referenced this pull requestJul 11, 2024
estyxx pushed a commit to estyxx/cpython that referenced this pull requestJul 17, 2024
…al sections (pythonGH-119366)Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
@koyuki7wkoyuki7w mentioned this pull requestDec 11, 2024
hugovk pushed a commit to hugovk/cpython that referenced this pull requestDec 11, 2024
…3 logical sections (pythonGH-119366)(cherry picked from commita26d27e)Co-authored-by: Carol Willing <carolcode@willingconsulting.com>Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
@bedevere-app
Copy link

GH-127811 is a backport of this pull request to the3.12 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.12only security fixes labelDec 11, 2024
hugovk added a commit that referenced this pull requestDec 11, 2024
…3 logical sections (GH-119366) (#127811)(cherry picked from commita26d27e)Co-authored-by: Carol Willing <carolcode@willingconsulting.com>Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
@hugovk
Copy link
Member

Backported to 3.12 to fix#127578.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@nedbatnedbatnedbat left review comments

@encukouencukouencukou approved these changes

@hugovkhugovkhugovk approved these changes

@rhettingerrhettingerrhettinger approved these changes

@ethanfurmanethanfurmanAwaiting requested review from ethanfurmanethanfurman is a code owner

@vsajipvsajipAwaiting requested review from vsajipvsajip is a code owner

@CAM-GerlachCAM-GerlachAwaiting requested review from CAM-Gerlach

Assignees

@encukouencukou

Labels
docsDocumentation in the Doc dirskip issueskip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

6 participants
@willingc@gvanrossum@encukou@hugovk@nedbat@rhettinger
[8]ページ先頭
©2009-2025 Movatter.jp