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

Docs: Interactive builds loop #5038

Open
medubelko opened this issue Sep 13, 2024 · 0 comments
Open

Docs: Interactive builds loop #5038

medubelko opened this issue Sep 13, 2024 · 0 comments
Assignees
Labels
documentation Documentation changes to the project itself or in-code help

Comments

@medubelko
Copy link
Contributor

Bug Description

As I covered recently, interactive builds run in an infinite loop.

To Reproduce

  1. Run:
    tox run -e autobuild-docs
    After it first builds, no issues are detected.
  2. Save a change to any RST file in /docs. The docs begin rebuilding in a loop.

Environment

System: Ubuntu 24.04
Environment: Snapcraft repo, no LXD/Multipass setup.

snapcraft.yaml

-

Relevant log output

[sphinx-autobuild] Detected change. Rebuilding...
[sphinx-autobuild] > sphinx-build -b html /home/med/dev/snapcraft/docs /home/med/dev/snapcraft/docs/_build

Additional context

@tigarmo This might be related to importing docs inside of other docs. Another TA reported similar issues a few months ago and their temporary solution was to exclude some of the content from rebuild. We found others that vouch for this being a possibility: sphinx-doc/sphinx#11556 (comment). I haven't looked into this deeply, though.

If we could get sphinx-autobuild to specify what files it detects have changed, this would be easier to diagnose, but even with the -v option it merely says Detected change.

@medubelko medubelko added the documentation Documentation changes to the project itself or in-code help label Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes to the project itself or in-code help
Projects
None yet
Development

No branches or pull requests

3 participants