9d91a072cd
This package is used for generation autodoc documentation automatically which can be linked to by Deckhand documentation from other places. This is to make autodoc generation work in RTD. More info: https://pypi.org/project/sphinxcontrib-apidoc/ Change-Id: I43aac82728e5935a5a2626f2fd29d7a7188d19f9
17 lines
480 B
Bash
Executable File
17 lines
480 B
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
# Builds documentation and generates documentation diagrams from .uml
|
|
# files. Must be run from root project directory.
|
|
|
|
set -ex
|
|
|
|
# Generate architectural diagrams.
|
|
mkdir -p doc/source/images
|
|
python -m plantuml doc/source/diagrams/*.uml
|
|
mv doc/source/diagrams/*.png doc/source/images
|
|
|
|
# Generate documentation.
|
|
rm -rf doc/build doc/source/contributor/api/ releasenotes/build
|
|
sphinx-apidoc -o doc/api deckhand
|
|
sphinx-build -W -b html doc/source doc/build/html
|