Skip to content

Commit f0e27ca

Browse files
committed
docs(developing): Note sphinx-autobuild
1 parent f9e986e commit f0e27ca

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/developing.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ Rerun tests on file change: `make watch_test` (requires [entr(1)])
1919

2020
## Documentation
2121

22+
[sphinx-autobuild] will automatically build the docs, watch for file changes and launch a server.
23+
24+
From home directory: `make start_docs`
25+
From inside `docs/`: `make start`
26+
27+
[sphinx-autobuild]: https://github.com/executablebooks/sphinx-autobuild
28+
29+
### Manual documentation (the hard way)
30+
2231
Default preview server: http://localhost:8022
2332

2433
`cd docs/` and `make html` to build. `make serve` to start http server.

0 commit comments

Comments
 (0)