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
This commit is contained in:
parent
0aae9dc177
commit
c81a88b963
2
Makefile
2
Makefile
@ -94,6 +94,8 @@ clean:
|
|||||||
rm -rf build
|
rm -rf build
|
||||||
helm delete helm-template ||:
|
helm delete helm-template ||:
|
||||||
rm -rf doc/build
|
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
|
.PHONY: docs
|
||||||
docs: clean build_docs
|
docs: clean build_docs
|
||||||
|
6
bindep.txt
Normal file
6
bindep.txt
Normal file
@ -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
|
@ -6,6 +6,7 @@ sphinx_rtd_theme
|
|||||||
reno>=2.5.0 # Apache-2.0
|
reno>=2.5.0 # Apache-2.0
|
||||||
plantuml
|
plantuml
|
||||||
sphinxcontrib-apidoc>=0.2.0 # BSD
|
sphinxcontrib-apidoc>=0.2.0 # BSD
|
||||||
|
sphinxcontrib-plantuml
|
||||||
|
|
||||||
# NOTE(felipemonteiro): Required by RTD to make oslo.policy and
|
# NOTE(felipemonteiro): Required by RTD to make oslo.policy and
|
||||||
# oslo.config sample generation work.
|
# oslo.config sample generation work.
|
||||||
|
@ -40,6 +40,7 @@ extensions = [
|
|||||||
'sphinx.ext.todo',
|
'sphinx.ext.todo',
|
||||||
'sphinx.ext.viewcode',
|
'sphinx.ext.viewcode',
|
||||||
'sphinxcontrib.apidoc',
|
'sphinxcontrib.apidoc',
|
||||||
|
'sphinxcontrib.plantuml',
|
||||||
'oslo_config.sphinxconfiggen',
|
'oslo_config.sphinxconfiggen',
|
||||||
'oslo_policy.sphinxpolicygen',
|
'oslo_policy.sphinxpolicygen',
|
||||||
# NOTE(fmontei): This is here so that readthedocs can publish releasenotes
|
# NOTE(fmontei): This is here so that readthedocs can publish releasenotes
|
||||||
|
@ -26,7 +26,7 @@ Airship components.
|
|||||||
Architecture
|
Architecture
|
||||||
============
|
============
|
||||||
|
|
||||||
.. image:: ../images/architecture.png
|
.. uml:: ../diagrams/architecture.uml
|
||||||
:alt: High level architecture of Deckhand
|
:alt: High level architecture of Deckhand
|
||||||
|
|
||||||
From a high-level perspective, Deckhand consists of a RESTful API, a document
|
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 <https://airship-pegleg.readthedocs.io/>`_ in effect provides
|
`Pegleg <https://airship-pegleg.readthedocs.io/>`_ in effect provides
|
||||||
Deckhand with a CLI, which facilitates communication with Deckhand.
|
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
|
:alt: High level architecture of Deckhand + Pegleg
|
||||||
|
|
||||||
Components
|
Components
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 37 KiB |
Binary file not shown.
Before Width: | Height: | Size: 23 KiB |
@ -5,11 +5,6 @@
|
|||||||
|
|
||||||
set -ex
|
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.
|
# Generate documentation.
|
||||||
rm -rf doc/build doc/source/contributor/api/ releasenotes/build
|
rm -rf doc/build doc/source/contributor/api/ releasenotes/build
|
||||||
sphinx-apidoc -o doc/api deckhand
|
sphinx-apidoc -o doc/api deckhand
|
||||||
|
Loading…
x
Reference in New Issue
Block a user