Skip to content

Conversation

@hugovk
Copy link
Member

@hugovkhugovk commented Dec 19, 2023

Like python/peps#3558 and python/devguide#1233.

When running make -C Docs htmllive, this will open the browser when the docs have been built the first time.

It means you don't need to hunt around for the link in:

make -C Doc htmllivemkdir -p buildBuilding NEWS from Misc/NEWS.d with blurb./venv/bin/sphinx-autobuild -b html -d build/doctrees -j auto --re-ignore="/venv/" --open-browser --delay 0 -W . build/html[sphinx-autobuild] > sphinx-build -b html -d build/doctrees -j auto -W /Users/hugo/github/python/cpython/main/Doc /Users/hugo/github/python/cpython/main/Doc/build/htmlRunning Sphinx v6.2.1loading pickled environment... donebuilding [mo]: targets for 0 po files that are out of datewriting output...building [html]: targets for 463 source files that are out of dateupdating environment: 0 added, 4 changed, 0 removedreading sources... [100%] whatsnew/changeloglooking for now-outdated files... none foundpickling environment... donechecking consistency... donepreparing documents... donewriting output... [100%] whatsnew/2.2 .. whatsnew/indexgenerating indices... genindex py-modindex donewriting additional pages... download index search opensearch donecopying images... [100%] using/win_installer.pngcopying downloadable files... [100%] includes/tzinfo_examples.pycopying static files... donecopying extra files... donedumping search index in English (code: en)... donedumping object inventory... doneWriting glossary.jsonbuild succeeded.The HTML pages are in build/html.[I 231219 15:20:27 server:335] Serving on http://127.0.0.1:8000[I 231219 15:20:27 handlers:62] Start watching changes[I 231219 15:20:27 handlers:64] Start detecting changes[I 231219 15:20:28 handlers:135] Browser Connected: http://127.0.0.1:8000/

Also make ALLSPHINXOPTS multiline to match https://github.com/python/devguide/blob/78fc0d7aa9fd0d6733d10c23b178b2a0e2799afc/Makefile#L18-L23 and https://github.com/python/peps/blob/9779c7efe63ab8dbb8bb673c5346c35505d97065/Makefile#L14-L17 to make it much easier to compare and maintain them.


📚 Documentation preview 📚: https://cpython-previews--113288.org.readthedocs.build/

@hugovkhugovk added docs Documentation in the Doc dir needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Dec 19, 2023
@hugovkhugovk merged commit 36adc79 into python:mainDec 26, 2023
@hugovkhugovk deleted the docs-make-htmllive-open-browser branch December 26, 2023 12:02
@miss-islington-app
Copy link

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@bedevere-app
Copy link

GH-113484 is a backport of this pull request to the 3.12 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 26, 2023
(cherry picked from commit 36adc79) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-appbedevere-appbot removed the needs backport to 3.12 only security fixes label Dec 26, 2023
@bedevere-app
Copy link

GH-113485 is a backport of this pull request to the 3.11 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 26, 2023
(cherry picked from commit 36adc79) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-appbedevere-appbot removed the needs backport to 3.11 only security fixes label Dec 26, 2023
hugovk added a commit that referenced this pull request Dec 26, 2023
) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Dec 26, 2023
) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
kulikjak pushed a commit to kulikjak/cpython that referenced this pull request Jan 22, 2024
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip issueskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@hugovk