Skip to content

Commit 26df667

Browse files
authored
update README with docs update info
1 parent 6dbeb78 commit 26df667

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,14 @@ poetry run pytest tests/test_dataset.py
5959
```
6060
poetry run pytest -m "not integration"
6161
```
62+
63+
**Updating documentation:**
64+
We use [Sphinx](https://www.sphinx-doc.org/en/master/) to autogenerate our API Reference from docstrings.
65+
66+
To test your local docstring changes, run the following commands from the repository's root directory:
67+
```
68+
poetry shell
69+
cd docs
70+
sphinx-autobuild . ./_build/html --watch ../nucleus
71+
```
72+
`sphinx-autobuild` will spin up a server on localhost (port 8000 by default) that will watch for and automatically rebuild a version of the API reference based on your local docstring changes.

0 commit comments

Comments
 (0)