8000 Clarify the documentation update process by miguelcsx · Pull Request #1395 · python/devguide · GitHub
[go: up one dir, main page]
Skip to content

Clarify the documentation update process #1395

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.

Sign up for GitHub

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 3 commits into from
Sep 19, 2024
Merged

Clarify the documentation update process #1395

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a9221a
refac: #1315 clarify cpython documentation update process
miguelcsx Sep 11, 2024
34dc1ce
refac: #1315 clarify cpython documentation update process
miguelcsx Sep 11, 2024
ed4821d
Update documentation/devguide.rst
miguelcsx Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update documentation/devguide.rst 
- followed the maintainer's instructions to keep it consistent.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
  • Loading branch information
@miguelcsx @AA-Turner
miguelcsx and AA-Turner authored Sep 19, 2024
commit ed4821d8f1012bcaa7b9f902ae8411afb59ec06b
10 changes: 6 additions & 4 deletions documentation/devguide.rst
View file 8B32
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ main Python documentation, except for some small differences. The source
lives in a `separate repository`_ and bug reports should be submitted to the
`devguide GitHub tracker`_.

Our devguide follows a continuous integration and deployment workflow, with changes published when pull requests are merged.
CPython documentation is updated regularly, typically within a day or two, depending on the build process.
The documentation is versioned for each CPython release, and updates are continuosly incorporated, though with some delay due the build time.
Aditionally, each CPython release includes a corresponding version of the documentation, which may also be used by redistributors.
Changes to the Developer's Guide are published when pull requests are merged.

Changes to the Python documentation are published regularly,
ususally within 48 hours of the change being committed.
The documentation is also `published for each release <https://docs.python.org/release/>`_,
which may also be used by redistributors.


Developer's Guide workflow
Expand Down
Loading
0