diff options
| author |   Michael Hwang <mhwang@research.att.com> | 2019-11-12 16:04:20 -0500 |
|---|---|---|
| committer | Michael Hwang <mhwang@research.att.com> | 2019-12-13 16:46:11 -0500 |
| commit | c698e66797bad69b4c77b26b487bf8322989beb0 (patch) | |
| tree | e40a8449728768107e4ab4c1ac506af13230a580 /mod/onboardingapi/docs/README.md | |
| parent | 9cb529e42f5625f2fa802e21919b10f814a89ca7 (diff) | |
Copy dcae-cli->onboardingapi, copy component specs
Issue-ID: DCAEGEN2-1860
Change-Id: I4805398c76479fad51cbdb74470ccc8f706ce9dc
Signed-off-by: Michael Hwang <mhwang@research.att.com>
Diffstat (limited to 'mod/onboardingapi/docs/README.md')
| -rw-r--r-- | mod/onboardingapi/docs/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/mod/onboardingapi/docs/README.md b/mod/onboardingapi/docs/README.md new file mode 100644 index 0000000..01685c8 --- /dev/null +++ b/mod/onboardingapi/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 +``` |