diff options
| author |   Michael Hwang <mhwang@research.att.com> | 2017-08-24 12:18:43 -0400 |
|---|---|---|
| committer | Michael Hwang <mhwang@research.att.com> | 2017-08-24 12:20:41 -0400 |
| commit | b86b42713a1fbfb1929bd5019aed7e5275b78d64 (patch) | |
| tree | 3caff5eacba397aa5960354ff8b4a00788544822 /dcae-cli/docs/README.md | |
| parent | d4c6fea2ab91b2e72cc188f10178f1f3cd8b99d5 (diff) | |
Add dcae-cli and component-json-schemas projects
Change-Id: I2d920da7902bb5c1faf3d66173d62c942e9a19e9
Issue-Id: DCAEGEN2-50
Signed-off-by: Michael Hwang <mhwang@research.att.com>
Diffstat (limited to 'dcae-cli/docs/README.md')
| -rw-r--r-- | dcae-cli/docs/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/dcae-cli/docs/README.md b/dcae-cli/docs/README.md new file mode 100644 index 0000000..01685c8 --- /dev/null +++ b/dcae-cli/docs/README.md @@ -0,0 +1,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 +``` |