Skip to content

Commit fe9a5d1

Browse files
committed
Add API docs instruction to README.md
1 parent db6686a commit fe9a5d1

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,18 @@ A number of labs are currently adopting DataJoint and we are quickly getting the
100100
* https://tutorials.datajoint.io -- step-by-step tutorials
101101
* https://catalog.datajoint.io -- catalog of example pipelines
102102

103+
### API docs
104+
105+
The API documentation can be built using sphinx by running
106+
107+
``` bash
108+
pip install sphinx sphinx_rtd_theme
109+
(cd docs-api/sphinx && make html)
110+
```
111+
112+
Generated docs are written to `docs-api/docs/html/index.html`.
113+
More details in [docs-api/README.md](docs-api/README.md).
114+
103115
## Running Tests Locally
104116

105117

0 commit comments

Comments
 (0)