Docs: Make previewing in development easier
Open
@JacobCoffee is already working on this.
Since Jul 2, 2024.
Assessment
This issue has not been assessed yet.
Description
Documentation
When needing to work on docs, I find the following a little cumbersome
psf-salt$ cd docs
psf-salt/docs$ make html && python -m http.server
It would be nice to have
- hot-reloading (sphinx-autobuild?)
- A
Makefiletarget in the root of the repo so that we could just runmake docs-serveor something to only need a oneshot command to get going
- Dominant language
- Hurl
- Stars
- 124
- Forks
- 67
- Avg merge
- 8h 40m
- Merged PRs (30d)
- 5
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.