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

Infra: don't let generated numerical.rst trigger rebuild loop #4103

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Nov 3, 2024

To reproduce:

$ make htmllive
...
The HTML pages are in build.
[sphinx-autobuild] Serving on http://127.0.0.1:55302
[sphinx-autobuild] Waiting to detect changes...

Then edit a file, for example peps/pep-0101.rst and it will rebuild it. So far, so good.

But then because peps/numerical.rst is regenerated, sphinx-autobuild detects a change and begins an infinite rebuild loop:

[sphinx-autobuild] Detected changes (peps/pep-0101.rst)
[sphinx-autobuild] Rebuilding...
...
The HTML pages are in build.
[sphinx-autobuild] Serving on http://127.0.0.1:55302
[sphinx-autobuild] Detected changes (peps/numerical.rst)
[sphinx-autobuild] Rebuilding...
...
The HTML pages are in build.
[sphinx-autobuild] Serving on http://127.0.0.1:55302
[sphinx-autobuild] Detected changes (peps/numerical.rst)
[sphinx-autobuild] Rebuilding...

Instead, ignore numerical.rst, just like the other generated files such as pep-0000.rst:

make htmllive
...
The HTML pages are in build.
[sphinx-autobuild] Serving on http://127.0.0.1:55302
[sphinx-autobuild] Waiting to detect changes...
[sphinx-autobuild] Detected changes (peps/pep-0101.rst)
[sphinx-autobuild] Rebuilding...
...
The HTML pages are in build.
[sphinx-autobuild] Serving on http://127.0.0.1:55302

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

@hugovk hugovk added the infra Core infrastructure for building and rendering PEPs label Nov 3, 2024
@AA-Turner AA-Turner merged commit 386f3ea into python:main Nov 5, 2024
6 checks passed
@hugovk hugovk deleted the infra-htmllive-ignore-numerical branch November 5, 2024 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra Core infrastructure for building and rendering PEPs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants