This patch updates Octavia docs to use the oslo_config.sphinxext
integration to generate the configuration reference.
This patch also links in the "guru meditation report" document.
This document has been present, but was not linked.
I also reorganized the specs to reflect the correct release versions.
Change-Id: Icaf710c1c61277f3ca51efac45a3a80a0d3cce8f
Octavia extensively uses TaskFlow flows for orchestration.
To make it easier for developers to understand these flows,
this patch adds a mechanism for generating graphviz representations
of the key Octavia TaskFlow flows.
It also updates our tox docs task to generate this documentation.
This patch depends on a fix to the TaskFlow export_to_dot method.
Added into conf.py as first step of configuration
Closes-Bug: #1561063
Change-Id: I914e1c062b400148565def37ccf618b3d2ea2573
Depends-On: I99f87af0b2bed959fcb43ef611b3186e23bd9549
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Closes-bug: #1529836
Change-Id: Ibdb8f13462e8416097006e19eb2214425364910e
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This can cause docs jobs to fail if the project errors out on
warnings.
Change-Id: Id2b52d22e7c946d75f421a8f731889d5afc34b9d
Related-Bug: #1368910
Along with defining terms, this commit cleans up some of the documentation
structure so the auto-generated docs are a bit cleaner.
Change-Id: I6445f86a6746956d8227d2a587509fe08b27d26d
The initial commit to allow graphviz images in documentation used
a sphinx extension relying on googlechart (which just sends the .dot files
to a google API and let's them render it). It turns out google's
implementation of the .dot renderer is quite out of date, and there's a
better module we can include which doesn't rely on this third party service
anyway.
Change-Id: I2bd10dc68d1d108af6bbf7f0e3871642f294eb8c
Every repo needs a first commit, eh? Most of this
is based on the neutron and neutron-specs project layouts.
Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
