Skip to content

Commit db6686a

Browse files
committed
Add README
1 parent 8fe05d8 commit db6686a

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs-api/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Datajoint API docs
2+
3+
To generate the documentation, run
4+
5+
``` bash
6+
(cd sphinx && make html)
7+
```
8+
9+
Docs will be placed in the `docs/` folder.
10+
11+
## Editing the docs
12+
13+
All source files are in `sphinx/source`.
14+
Docs are currently structured as follows:
15+
16+
```
17+
sphinx/source/conf.py # Sphinx configuration file
18+
sphinx/source/index.rst # This is the docs front page
19+
sphinx/source/datajoint.*.rst # Docs for different modules
20+
```

0 commit comments

Comments
 (0)