openedx / openedx/docs.openedx.org

Sphinx autobuild builds indefinitely after first loaded change

Open
#641 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

build-issue
Dominant language
JavaScript
Stars
35
Forks
95
Avg merge
5d 15h
Merged PRs (30d)
3

Description

Description

After running make serve_docs for the first time and making a single change, the autobuild extension doesn't stop building docs like there were an indefinite amount of saves:

Screencast from 10-12-24 14:34:55.webm

The only way to stop the autobuild is by manually stopping the process. Is this the usual behavior?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running make serve_docs, then make one documentation change and observe whether the Sphinx autobuild process repeats indefinitely. Inspect the serve_docs entry point and the autobuild configuration mentioned by the issue; done means one change triggers a normal rebuild and the process stops rebuilding when no further changes are made.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.