sphinx-contrib / sphinx-contrib/openapi
Support sphinx-autobuild
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
I'm trying to use sphinx-autobuild and sphinxcontrib-openapi together but I think that sphinxcontrib-openapi is doing some type of caching that is blocking sphinx-autobuild to work as expected when editing the OpenAPI YAML file.
Contributor guide
No contributing guide indexed for this repository
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
Reproduce the issue using sphinx-autobuild, sphinxcontrib-openapi, and an OpenAPI YAML file. Inspect how the extension handles changes to that YAML while the documentation server is running. Done means editing the YAML causes the generated Sphinx documentation to rebuild and reflect the change without restarting the process.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100