diff --git a/Makefile b/Makefile index e513c7de..7489a6c4 100644 --- a/Makefile +++ b/Makefile @@ -94,6 +94,8 @@ clean: rm -rf build helm delete helm-template ||: rm -rf doc/build + # Don't remove .placeholder from doc/source/_static/ + rm -rf doc/api doc/source/_static/* doc/source/contributor/api .PHONY: docs docs: clean build_docs diff --git a/bindep.txt b/bindep.txt new file mode 100644 index 00000000..b8ef165e --- /dev/null +++ b/bindep.txt @@ -0,0 +1,6 @@ +# This file contains runtime (non-python) dependencies +# More info at: https://docs.openstack.org/infra/bindep/readme.html + +# PlantUML is used for documentation builds, graphviz is it's soft dependancy +plantuml +graphviz diff --git a/doc/requirements.txt b/doc/requirements.txt index 08ab488f..755facfb 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -6,6 +6,7 @@ sphinx_rtd_theme reno>=2.5.0 # Apache-2.0 plantuml sphinxcontrib-apidoc>=0.2.0 # BSD +sphinxcontrib-plantuml # NOTE(felipemonteiro): Required by RTD to make oslo.policy and # oslo.config sample generation work. diff --git a/doc/source/conf.py b/doc/source/conf.py index 62f3c118..08dd88f9 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -40,6 +40,7 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinxcontrib.apidoc', + 'sphinxcontrib.plantuml', 'oslo_config.sphinxconfiggen', 'oslo_policy.sphinxpolicygen', # NOTE(fmontei): This is here so that readthedocs can publish releasenotes diff --git a/doc/source/contributor/developer-overview.rst b/doc/source/contributor/developer-overview.rst index 718ec622..eba1bb3f 100644 --- a/doc/source/contributor/developer-overview.rst +++ b/doc/source/contributor/developer-overview.rst @@ -26,7 +26,7 @@ Airship components. Architecture ============ -.. image:: ../images/architecture.png +.. uml:: ../diagrams/architecture.uml :alt: High level architecture of Deckhand From a high-level perspective, Deckhand consists of a RESTful API, a document @@ -41,7 +41,7 @@ Deckhand uses Barbican to securely storage sensitive document data. `Pegleg `_ in effect provides Deckhand with a CLI, which facilitates communication with Deckhand. -.. image:: ../images/architecture-pegleg.png +.. uml:: ../diagrams/architecture-pegleg.uml :alt: High level architecture of Deckhand + Pegleg Components diff --git a/doc/source/images/architecture-pegleg.png b/doc/source/images/architecture-pegleg.png deleted file mode 100644 index 85428fbe..00000000 Binary files a/doc/source/images/architecture-pegleg.png and /dev/null differ diff --git a/doc/source/images/architecture.png b/doc/source/images/architecture.png deleted file mode 100644 index 225a7948..00000000 Binary files a/doc/source/images/architecture.png and /dev/null differ diff --git a/tools/build-docs.sh b/tools/build-docs.sh index ec2e4372..198c0bd4 100755 --- a/tools/build-docs.sh +++ b/tools/build-docs.sh @@ -5,11 +5,6 @@ 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