diff --git a/docs/source/content/contributing.md b/docs/source/content/contributing.md index ce66ef258..b92c97410 100644 --- a/docs/source/content/contributing.md +++ b/docs/source/content/contributing.md @@ -48,6 +48,9 @@ in the docstring, and this will then automatically generate the API docs when me They will also be automatically checked with [pytest](https://docs.pytest.org/) (via [doctest](https://docs.python.org/3/library/doctest.html)). +If you want to view your documentation changes, run `pytest run docs-hot-reload`. This will give you +hot-reloading docs (they change in real time as you edit docstrings). + ### Docstring Style Guide We follow the Google Python Docstring Style for writing docstrings, with some added features from diff --git a/makefile b/makefile index a17630f9b..cdc3493b9 100644 --- a/makefile +++ b/makefile @@ -25,3 +25,9 @@ test: make acceptance-test make docstring-test make notebook-test + +docs-hot-reload: + poetry run docs-hot-reload + +build-docs: + poetry run build-docs