summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoman Gorshunov <roman.gorshunov@att.com>2019-02-07 00:37:10 +0100
committerRoman Gorshunov <roman.gorshunov@att.com>2019-02-14 13:55:44 +0100
commitc81a88b9636975d26520486e0ea26d960e98e893 (patch)
tree20e8b0a2844512cf1e2a319c7a7db38286f12f75
parent0aae9dc1776bd97ab8f4152a51baedb24eb61396 (diff)
Embed UML generated diagrams into docs, fix docs build
Remove manual generation of UML diagrams; they will be built by Sphinx itself. Require to install PlantUML and Graphviz via bindep in openstack-tox-docs job; ReadTheDocs service already has both PlantUML and Graphviz installed for documentation builds. Change-Id: I21ab124a80e7768bc9edd891b975b4e0f8a6e50d Story: 2004747
Notes
Notes (review): Code-Review+1: Vladyslav Drok <vdrok@mirantis.com> Code-Review+2: Felipe Monteiro <felipe.monteiro@att.com> Code-Review+1: Drew Walters <drewwalters96@gmail.com> Code-Review+1: Michael Beaver <michaelbeaver64@gmail.com> Code-Review+1: Nishant Kumar <nishant.e.kumar@ericsson.com> Code-Review+2: Bryan Strassner <strassner.bryan@gmail.com> Workflow+1: Bryan Strassner <strassner.bryan@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Wed, 20 Feb 2019 22:36:39 +0000 Reviewed-on: https://review.openstack.org/635357 Project: openstack/airship-deckhand Branch: refs/heads/master
-rw-r--r--Makefile2
-rw-r--r--bindep.txt6
-rw-r--r--doc/requirements.txt1
-rw-r--r--doc/source/conf.py1
-rw-r--r--doc/source/contributor/developer-overview.rst4
-rw-r--r--doc/source/images/architecture-pegleg.pngbin37602 -> 0 bytes
-rw-r--r--doc/source/images/architecture.pngbin23232 -> 0 bytes
-rwxr-xr-xtools/build-docs.sh5
8 files changed, 12 insertions, 7 deletions
diff --git a/Makefile b/Makefile
index e513c7d..7489a6c 100644
--- a/Makefile
+++ b/Makefile
@@ -94,6 +94,8 @@ clean:
94 rm -rf build 94 rm -rf build
95 helm delete helm-template ||: 95 helm delete helm-template ||:
96 rm -rf doc/build 96 rm -rf doc/build
97 # Don't remove .placeholder from doc/source/_static/
98 rm -rf doc/api doc/source/_static/* doc/source/contributor/api
97 99
98.PHONY: docs 100.PHONY: docs
99docs: clean build_docs 101docs: clean build_docs
diff --git a/bindep.txt b/bindep.txt
new file mode 100644
index 0000000..b8ef165
--- /dev/null
+++ b/bindep.txt
@@ -0,0 +1,6 @@
1# This file contains runtime (non-python) dependencies
2# More info at: https://docs.openstack.org/infra/bindep/readme.html
3
4# PlantUML is used for documentation builds, graphviz is it's soft dependancy
5plantuml
6graphviz
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 08ab488..755facf 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -6,6 +6,7 @@ sphinx_rtd_theme
6reno>=2.5.0 # Apache-2.0 6reno>=2.5.0 # Apache-2.0
7plantuml 7plantuml
8sphinxcontrib-apidoc>=0.2.0 # BSD 8sphinxcontrib-apidoc>=0.2.0 # BSD
9sphinxcontrib-plantuml
9 10
10# NOTE(felipemonteiro): Required by RTD to make oslo.policy and 11# NOTE(felipemonteiro): Required by RTD to make oslo.policy and
11# oslo.config sample generation work. 12# oslo.config sample generation work.
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 62f3c11..08dd88f 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -40,6 +40,7 @@ extensions = [
40 'sphinx.ext.todo', 40 'sphinx.ext.todo',
41 'sphinx.ext.viewcode', 41 'sphinx.ext.viewcode',
42 'sphinxcontrib.apidoc', 42 'sphinxcontrib.apidoc',
43 'sphinxcontrib.plantuml',
43 'oslo_config.sphinxconfiggen', 44 'oslo_config.sphinxconfiggen',
44 'oslo_policy.sphinxpolicygen', 45 'oslo_policy.sphinxpolicygen',
45 # NOTE(fmontei): This is here so that readthedocs can publish releasenotes 46 # 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 718ec62..eba1bb3 100644
--- a/doc/source/contributor/developer-overview.rst
+++ b/doc/source/contributor/developer-overview.rst
@@ -26,7 +26,7 @@ Airship components.
26Architecture 26Architecture
27============ 27============
28 28
29.. image:: ../images/architecture.png 29.. uml:: ../diagrams/architecture.uml
30 :alt: High level architecture of Deckhand 30 :alt: High level architecture of Deckhand
31 31
32From a high-level perspective, Deckhand consists of a RESTful API, a document 32From 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.
41`Pegleg <https://airship-pegleg.readthedocs.io/>`_ in effect provides 41`Pegleg <https://airship-pegleg.readthedocs.io/>`_ in effect provides
42Deckhand with a CLI, which facilitates communication with Deckhand. 42Deckhand with a CLI, which facilitates communication with Deckhand.
43 43
44.. image:: ../images/architecture-pegleg.png 44.. uml:: ../diagrams/architecture-pegleg.uml
45 :alt: High level architecture of Deckhand + Pegleg 45 :alt: High level architecture of Deckhand + Pegleg
46 46
47Components 47Components
diff --git a/doc/source/images/architecture-pegleg.png b/doc/source/images/architecture-pegleg.png
deleted file mode 100644
index 85428fb..0000000
--- a/doc/source/images/architecture-pegleg.png
+++ /dev/null
Binary files differ
diff --git a/doc/source/images/architecture.png b/doc/source/images/architecture.png
deleted file mode 100644
index 225a794..0000000
--- a/doc/source/images/architecture.png
+++ /dev/null
Binary files differ
diff --git a/tools/build-docs.sh b/tools/build-docs.sh
index ec2e437..198c0bd 100755
--- a/tools/build-docs.sh
+++ b/tools/build-docs.sh
@@ -5,11 +5,6 @@
5 5
6set -ex 6set -ex
7 7
8# Generate architectural diagrams.
9mkdir -p doc/source/images
10python -m plantuml doc/source/diagrams/*.uml
11mv doc/source/diagrams/*.png doc/source/images
12
13# Generate documentation. 8# Generate documentation.
14rm -rf doc/build doc/source/contributor/api/ releasenotes/build 9rm -rf doc/build doc/source/contributor/api/ releasenotes/build
15sphinx-apidoc -o doc/api deckhand 10sphinx-apidoc -o doc/api deckhand