File: sphinx_reload.py

package info (click to toggle)
python-django-crispy-forms-foundation 1.1.0%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 880 kB
  • sloc: javascript: 6,437; python: 1,326; makefile: 200; sh: 17
file content (34 lines) | stat: -rw-r--r-- 961 bytes parent folder | download
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
#!/usr/bin/env python
"""
A script to launch a livereload server to watch and rebuild documentation on sources
changes.

You need to have project with documentation requirements 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 pathlib import Path

from livereload import Server, shell

server = Server()

# Watch document sources
server.watch("docs/*.rst", shell("make html", cwd="docs"))
server.watch("docs/*/**.rst", shell("make html", cwd="docs"))
server.watch("*.rst", shell("make html", cwd="docs"))


# Watch Python modules for autodoc review
server.watch("crispy_forms_foundation/*.py", shell("make html", cwd="docs"))
server.watch("crispy_forms_foundation/*/**.py", shell("make html", cwd="docs"))

# Serve the builded documentation
server.serve(root="docs/_build/html", port=8002, host="0.0.0.0")