Commit 91ae5aa
committed
[docs] Adds sphinx extensions
Note that for `sphinx-apidoc` to work we need a `__init__.py` file on
the `sagittal_average` library. Add it if not done
before. Alternatively you can pass the `--implicit-namespaces` flag to
`sphinx-apidoc` if you prefer to have a native namespace package.
Steps to build the docs
```bash
sphinx-apidoc -o ./docs/api ./src/sagittal_average
cd docs
make html # Assuming the library is installed
python -m http.server -d _build/html # to view the automatically built documentation
```1 parent 58a9cf5 commit 91ae5aa
2 files changed
+7
-1
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
18 | 23 | | |
19 | 24 | | |
20 | 25 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| 13 | + | |
0 commit comments