-
Notifications
You must be signed in to change notification settings - Fork 72
Add a Python documentation sprint topic #1454
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 13 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
8e4343b
Expand the Python sprint to cover documentation
AA-Turner 43805b8
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] e38aa89
Merge branch 'ep2025' into sprints/python-docs
hugovk ac76eaf
Update cpython.md
AA-Turner 3ec3262
Update cpython.md
AA-Turner 11dd32d
Update cpython.md
AA-Turner 4ae9026
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 01aecff
H5
AA-Turner bd80063
H5
AA-Turner 6fb2e39
Split the pages
AA-Turner 6d3f192
Add missing closing quotation marks
AA-Turner 62098b3
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] a7b9de8
Merge branch 'ep2025' into sprints/python-docs
AA-Turner 37ca695
Update cpython-documentation.md
AA-Turner ee54c0a
Update cpython-documentation.md
AA-Turner 8091d08
Update cpython-documentation.md
AA-Turner File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| title: "Python Documentation" | ||
| numberOfPeople: "TBA" | ||
| pythonLevel: "Any" | ||
| contactPerson: | ||
| name: "Adam Turner" | ||
| github: AA-Turner | ||
| links: | ||
| - title: "Start Documenting" | ||
| url: "https://devguide.python.org/documentation/start-documenting/" | ||
| - title: "Helping with Documentation" | ||
| url: "https://devguide.python.org/documentation/help-documenting/" | ||
| - title: "Easy Issues" | ||
| url: "https://github.com/python/cpython/issues?q=is%3Aissue%20is%3Aopen%20label%3Adocs%20label%3Aeasy" | ||
| - title: "Code of Conduct" | ||
| url: "https://policies.python.org/python.org/code-of-conduct/" | ||
| --- | ||
|
|
||
| Help us improve the Python documentation! | ||
|
|
||
| We'll be working on all parts of the documentation, so all any any changes are | ||
| welcome -- from fixing a spelling error to documenting a new feature. | ||
|
|
||
| 1. Read | ||
| ['what to expect'](https://pycon.blogspot.com/2025/04/pyconus-sprints.html) | ||
| for a briefing on what happens at sprints in general. This was written for | ||
| the PyCon US sprints, but a lot applies here!. | ||
AA-Turner marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. Fork and clone the [repository](https://github.com/python/cpython/fork) | ||
| **before** arriving at the sprints, to get started faster. | ||
| 1. Use the | ||
| [Python Developer's Guide](https://devguide.python.org/getting-started/setup-building/) | ||
AA-Turner marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| to set up an environment for contributing to the documentation. | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.