DOC: Add Sphinx-autobuild to documentation environment
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
What is your issue?
I realised while doing #10732 that the contributing instructions for building documentation is the following:
I find this build then manually open to be a bit out of my normal workflow (and for what I've seen quite a bit), as opposed to using sphinx-autobuild something like
sphinx-autobuild docs docs/_build
Which launches a server and rebuilds the documentation on change to the documentation.
Would this be something devs are interested in?
Changes needed:
- add
sphinx-autobuildas a dependency - add a task
pixi run doc-watchto spin up the server (and still havepixi run docin case people just want to build and not watch) - update contributing instructions
I can do this alongside the PR for #10732 (preferred from my end) or in a subsequent PR if you'd prefer that.
I searched the issue tracker - couldn't find a mention of sphinx-autobuild
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with doc/contribute/contributing.rst and the existing pixi run doc workflow, then locate the project configuration for documentation dependencies and tasks. Done means a pixi run doc-watch command starts the documented server and rebuilds on documentation changes, while the contributing instructions explain both workflows.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100