Skip to content
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

Clarify the documentation update process #1395

Merged
merged 3 commits into from
Sep 19, 2024

Conversation

miguelcsx
Copy link
Contributor

@miguelcsx miguelcsx commented Sep 11, 2024

  • update the documentation to specify that cpython docs are updated daily

  • removed the previous implication that updates occur only with cpython releases

  • clarified the connection between daily updates and the cpython release workflow

Description

This PR updates the documentation to clarify the update workflow for the CPython documentation. The previous text implied that updates only occurred with CPython releases, but the documentation is actually updated on a daily basis. This change ensures accurate and up-to-date information about the documentation workflow.

Changes Made

  • Revised the description of the CPython documentation update process.

Reason for Change

The original text did not fully reflect the frequency of CPython documentation updates. By specifying that updates occur daily, this pull request provides a more accurate representation of the documentation workflow.

Impact

This change will ensure that users are correctly informed about the update schedule for CPython documentation, enhancing transparency and understanding of the documentation process.


📚 Documentation preview 📚: https://cpython-devguide--1395.org.readthedocs.build/

- update the documentation to specify that cpython docs are updated daily

- removed the previous implication that updates occur only with cpython
  releases

  - clarified the connection between daily updates and the cpython
    release workflow
Copy link

cpython-cla-bot bot commented Sep 11, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

@hugovk
Copy link
Member

hugovk commented Sep 11, 2024

Thanks for the PR.

However, the CPython docs aren't updated daily.

Short version: it's currently taking over 40 hours.

Longer version:

What happens is: there's an hourly cron on the docs build server. If there's a build currently running, that build continues, and the hourly check stops. If there's no build running, a new one starts.

It will then check each active branch (currently 3.12-3.14) and all the translations.

If there are docs changes since last run, or changes to translations, that version/language will be rebuilt.

It takes a long time to build all these docs, especially the PDFs. Recently it's been taking over 40 hours.

By the time a full build has finished, because it took so long, inevitably there are new changes on the next loop, requiring a full build yet again.

See python/docsbuild-scripts#190 for efforts to improve this.

Okay, so that's one part of it. The other is releases. Docs are built during releases, and can be found here: https://www.python.org/doc/versions/

@hugovk
Copy link
Member

hugovk commented Sep 11, 2024

And I realise I'm contradicting what I wrote in #1315, but I've learned a lot about the docs build process in recent months :)

So perhaps if we hedge and say something like "about once a day"?

(I'm hoping further work at python/docsbuild-scripts#190 and especially python/docs-community#5 will mean we can get the HTML docs updated much sooner after update, perhaps even within an hour.)

@miguelcsx
Copy link
Contributor Author

And I realise I'm contradicting what I wrote in #1315, but I've learned a lot the docs build process in recent months :)

So perhaps if we hedge and say something like "about once a day"?

(I'm hoping further work at python/docsbuild-scripts#190 and especially python/docs-community#5 will mean we can get the HTML docs updated much sooner after update, perhaps even within an hour.)

@hugovk Ok, I'll update to make sure it's clear to understand, thanks for the clarification.

- updated the explanation of cpython documentation updates

- specified that updates occur regularly, tipically within a day or two

- clarified that the documentation is versioned for each cpython release

- improved the clarity of the relationship between releases and versions
@AA-Turner AA-Turner changed the title refac: #1315 clarify cpython documentation update process Clarify the documentation update process Sep 18, 2024
- followed the maintainer's instructions to keep it consistent.

Co-authored-by: Adam Turner <[email protected]>
@AA-Turner AA-Turner merged commit 9ef7702 into python:main Sep 19, 2024
4 checks passed
@AA-Turner
Copy link
Member

Thanks @miguelcsx

A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants