Skip to content

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Sep 4, 2025

Since python/release-tools#71 the docs have been automatically built in the CI and there's no manual tasks for the Docs Expert as part of PEP 101.

cc @JulienPalard


📚 Documentation preview 📚: https://pep-previews--4574.org.readthedocs.build/

@@ -388,8 +387,6 @@ and guides you to perform some manual steps.
``docs.nyc1.psf.io``. Make sure the files are in group ``docs`` and are
group-writeable.

- Let the DE check if the docs are built and work all right.
Copy link
Member

Choose a reason for hiding this comment

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

Arguably this step could be kept (modulo whoever does the checking), there have been recent releases where the docs haven't built properly, so it was important to check, even though CI failing/hanging alerted us to this.

A

Copy link
Member Author

Choose a reason for hiding this comment

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

There's not actually a step in the automation scripts at https://github.com/python/release-tools that does this (or pauses to get someone to check it), other than the CI passing.

We could add one, if we can define something useful?

Copy link
Member

Choose a reason for hiding this comment

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

Arguably at minimum, the HTML files should seem fine at dip-test level, the EPUB file should pass EPUBcheck, the PDF archives should contain the expected files & not be corrupt, etc. These feel like reasonable checks?

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.

2 participants