Skip to content

Add --select-output - #199

Merged
AA-Turner merged 3 commits into
python:mainfrom
AA-Turner:select-output
Sep 26, 2024
Merged

AA-Turner merged 3 commits into
python:mainfrom
AA-Turner:select-output

Conversation

@AA-Turner

Copy link
Copy Markdown
Member

Towards python/docs-community#131

If either of the options to --select-output is given, a different lockfile is generated and checked. We also invert some options because in the future both HTML and non-HTML builds will require archiving their files, so we only skip archiving when --quick is passed.

If --select-output is missing, the current behaviour is retained, so merging this should have no impact on the current process.

I believe that running rsync -a --delete-delay --filter P archives/ <build path> <target path> is harmless on quick builds, so we remove an if/else here.

@AA-Turner

Copy link
Copy Markdown
Member Author

A thought -- is there a risk of overwriting here?

If one process is building the Python 3.12 documentation in French, and a HTML builder is started for Python 3.12 in English, then build/doctrees could become inconsistent with some French doctrees and some English. Worse, the two processes could be running different builders, changing the checked-out state of the repository.

Prudence seems to suggest that we should use a different checkout for the HTML builds?

A

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

A thought -- is there a risk of overwriting here?

If one process is building the Python 3.12 documentation in French, and a HTML builder is started for Python 3.12 in English, then build/doctrees could become inconsistent with some French doctrees and some English. Worse, the two processes could be running different builders, changing the checked-out state of the repository.

Prudence seems to suggest that we should use a different checkout for the HTML builds?

Yes, that sounds wise.

Comment thread build_docs.py Outdated
@AA-Turner
AA-Turner requested a review from hugovk September 26, 2024 16:53

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you!

@AA-Turner
AA-Turner merged commit 5d26f06 into python:main Sep 26, 2024
@AA-Turner
AA-Turner deleted the select-output branch September 26, 2024 22:08
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