summaryrefslogtreecommitdiffstats
path: root/dcae-cli/docs/README.md
blob: 01685c82dfe1f0bf6e6703bd4f8cb280fe0c9731 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# Documentation build instructions

The autodoc extension doesn't regenerate the `dcae_cli` package files in the build directory. They can be recreated via:

```
sphinx-apidoc -o source/apidoc/ ../dcae_cli/
```

Then the HTML can be rebuilt via:

```
make clean
make html
```

The makefile was initially created via:

```
sphinx-quickstart
```