-
Notifications
You must be signed in to change notification settings - Fork 0
/
sphinx_reload.py
61 lines (49 loc) · 1.05 KB
/
sphinx_reload.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
#!/usr/bin/env python
"""
A script to launch a livereload server to watch and rebuild documentation
on some sources changes.
You need to have installed package with extra requirements ``dev`` to use it.
Once launched, server will be available on port 8002, like: ::
http://localhost:8002/
Borrowed from: ::
https://livereload.readthedocs.io/en/latest/#script-example-sphinx
"""
from livereload import Server, shell
server = Server()
# Watch root documents (not recursive)
server.watch(
"docs/*.rst",
shell(
"make html",
cwd="docs"
)
)
# Watch application documents
server.watch(
"docs/core/*.rst",
shell(
"make html",
cwd="docs"
)
)
# Watch Python modules for autodoc review
server.watch(
"project_composer/*.py",
shell(
"make html",
cwd="docs"
)
)
server.watch(
"project_composer/*/**.py",
shell(
"make html",
cwd="docs"
)
)
# Serve the builded documentation
server.serve(
root="docs/_build/html",
port=8002,
host="0.0.0.0",
)