make htmllive: open browser when ready - #1233
hugovk merged 1 commit into
Conversation
Sorry, something went wrong.
So this will build the docs (or possibly rebuild just the files changed since the last time), then open the browser immediately, and then keep refreshing the page without opening new browser tabs, right? Are there cases where the browser will open before the docs are built? (The --delay suggests there might be, but I haven't tried the PR) |
Sorry, something went wrong.
Correct, it goes like this: $ make htmllive
[1. Sphinx builds the docs]
[2. page opened in browser]
[3. user edits and saves]
[4. Sphinx rebuilds the docs]
[5. browser refreshes]
[6. goto 3]
I don't think so, and I've not run into it in a few weeks of testing. The default is 5 seconds, which feels a long time with nothing happening, and then the browser suddenly opening. We can always increase it later if needed. ❯ sphinx-autobuild --help
...
--open-browser open the browser after building documentation (default: False)
--delay DELAY how long to wait before opening the browser (default: 5) |
Sorry, something went wrong.
When running make 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:
I'll make the same changes for CPython and PEPs repo afterwards.
📚 Documentation preview 📚: https://cpython-devguide--1233.org.readthedocs.build/