Skip to content

Commit

Permalink
Add docs hot reloading instructions for contributors (#436)
Browse files Browse the repository at this point in the history
Note these are also added to the makefile as this is currently the approach people use to run the tests. In the future we should probably remove this as it's better to stick to one language in the repo (and a .py script file can also do all of this).
  • Loading branch information
alan-cooney authored Oct 22, 2023
1 parent 19ab304 commit 59d8388
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/source/content/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 59d8388

Please sign in to comment.