Skip to content

Commit 8198c4d

Browse files
committed
🔧 tox: add docs-live environment
1 parent d1d21a7 commit 8198c4d

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

requirements-docs.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ sphinx-design2
44
sphinxext-rediraffe
55
sphinx-subfigure
66
ablog~=0.11.1
7+
sphinx-autobuild
78
pyyaml

tox.ini

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ commands =
6666

6767

6868
[testenv:docs-{update,clean}]
69-
description =
69+
description =
7070
clean: Build the documentation (remove any existing build)
7171
update: Build the documentation (modify any existing build)
7272
deps = -rrequirements-docs.txt
@@ -75,6 +75,11 @@ commands =
7575
clean: rm -rf docs/_build
7676
sphinx-build -nW --keep-going -b {posargs:html} docs/ docs/_build/{posargs:html}
7777

78+
[testenv:docs-live]
79+
description = Build and serve documentation with live reload
80+
deps = -rrequirements-docs.txt
81+
commands = sphinx-autobuild -nW --watch docs/ --open-browser docs/ docs/_build/html
82+
7883
[testenv:openstack]
7984
description = Retrieve an API Key from OpenStack
8085
deps =

0 commit comments

Comments
 (0)