diff options
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 +``` |