Merge branch '3.x-line' into dev

marshmallow-code · Jan 18, 2025 · f8b86b9 · f8b86b9
2 parents db43fc0 + abc4ea9
commit f8b86b9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -135,13 +135,13 @@ Documentation
 
 Contributions to the documentation are welcome. Documentation is written in `reStructuredText`_ (rST). A quick rST reference can be found `here <https://docutils.sourceforge.io/docs/user/rst/quickref.html>`_. Builds are powered by Sphinx_.
 
-To build the docs in "watch" mode:
+To build and serve the docs in "watch" mode:
 
 .. code-block:: shell-session
 
-   $ tox -e watch-docs
+   $ tox -e docs-serve
 
-Changes in the `docs/` directory will automatically trigger a rebuild.
+Changes to documentation will automatically trigger a rebuild.
 
 
 .. _contributing_examples:

diff --git a/tox.ini b/tox.ini
@@ -22,12 +22,12 @@ commands = sphinx-build --fresh-env docs/ docs/_build {posargs}
 
 ; Below tasks are for development only (not run in CI)
 
-[testenv:watch-docs]
+[testenv:docs-serve]
 deps = sphinx-autobuild
 extras = docs
-commands = sphinx-autobuild --open-browser docs/ docs/_build {posargs} --watch src/marshmallow --delay 2
+commands = sphinx-autobuild --port=0 --open-browser --delay=2 docs/ docs/_build {posargs} --watch src --watch CONTRIBUTING.rst --watch README.rst
 
-[testenv:watch-readme]
+[testenv:readme-serve]
 deps = restview
 skip_install = true
 commands = restview README.rst