Merge pull request #1872 from chrysle/tox-preview-env

Add docs preview env for `tox`

Author: chrysle

tox.ini

@@ -92,6 +92,37 @@ skip_install = true
 allowlist_externals =
   git
 
+
+[testenv:preview-docs]
+description = preview the docs
+deps =
+  sphinx-autobuild
+  {[testenv:build-docs]deps}
+commands_pre =
+commands =
+  # Retrieve possibly missing commits:
+  -git fetch --unshallow
+  -git fetch --tags
+
+  # Build the html docs with sphinx-autobuild:
+  {envpython} -m sphinx_autobuild \
+    -j auto \
+    -b html \
+    -n \
+    -W \
+    -d "{temp_dir}/.doctrees" \
+    . \
+    --watch ../README.rst \
+    --watch ../CHANGELOG.md \
+    "{envdir}/docs_out"
+
+changedir = {[testenv:build-docs]changedir}
+isolated_build = {[testenv:build-docs]isolated_build}
+passenv = {[testenv:build-docs]passenv}
+skip_install = {[testenv:build-docs]skip_install}
+allowlist_externals = {[testenv:build-docs]allowlist_externals}
+
+
 [testenv:linkcheck-docs]
 description = check links in the documentation
 deps =