A Starlingx patch[1] changed the signature for some openstackdocstheme
methods which is causing Octavia docs to not build.
This patch updates the octavia docs configuration for the new
openstackdocstheme.
[1] https://review.openstack.org/#/c/607298
Change-Id: Id09ab3b78291c28e116f1f4ffb8836eac0537d94
OpenStack requirements has added pydot to global requirements.
Even though this isn't the proper fix (still pending networkx 2.2 release)
this will resolve the dependency issue for us, so re-enabling our
flow diagrams.
Change-Id: I49856c8fbd7cb6302be4ec97a14b2c10682cf504
The networkx package changed their dependecy model in version 2.1 and
now uses "pydot" and adds the dependency via setuptools "extras".
Unfortunately they only define an "extra" of "all" which installs packages
we do not need and fail to install.
So until the "extras" are fixed in networkx, we need to disable flow
diagraming.
Change-Id: I4f9082c267dc7da14b81cb551eeb10bbf58c175a
See: https://github.com/networkx/networkx/pull/3080
Upper requirements recently bumped sphinx from 1.6.5 to 1.7.4 which
breaks our docs job. This switches the apidocs build to use
sphinxcontrib.apidoc.
Change-Id: If6b9aa070d37f2799623a24a8e18666b13ef9044
This patch re-enables the page Table of Contents (ToC) for the Octavia
documentation. Previously the theme had the table of contents at the top
of each page which cluttered our index pages. Now the theme based ToC is
located on the left navigation menu.
This patch also reorganizes the user documentation section and adds a link
to our "Introduction to OpenStack Load Balancing" presentation from the
2017 Boston summit.
This change will not impact bookmarks.
Change-Id: Ib200f8b95e216b081d884da017fa1cce85f48763
This patch updates the docs configuration to have bugs links that take the
reporter to storyboad instead of launchpad.
It also sets the docs up for PDF rendering and multiple versions of the
documentation.
Change-Id: I66187e09e038efe605db45a26e3505218a7a4c65
The 'import tools' line is fragile as it depends on how things are
executed as to whether or not '.' is in the python path.
Do the sphinx path munging before importing it.
Also, remove reference to modules/autoindex which does not exist and
thus causes sadness from warning-is-error.
Moves documentation requirements into doc/requirements.txt
Depends-On: Ib121961c5a953a434e7b333cd70f7838a2671f69
Change-Id: I23691aa1d0ea038ec1215e6199015529ddd92de4
This patch adds automatic Entity Relationship Diagraming (ERD) for
the Octavia database schema. The ERD will be available as part of the
Octavia developer reference documentation.
Story: 1558379
Task: 5271
Change-Id: I282b4128fcc72babd1a128d95ec0b3342802c2d4
This patch updates the Octavia documentation in support of the
OpenStack documentation migration[1].
[1] https://specs.openstack.org/openstack/docs-specs/specs \
/pike/os-manuals-migration.html
Change-Id: I97fd038b8050bfe776c3fca8336d9090f8236362
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
This patch adds policies and enforcement to the Octavia v2 API for
load balancers and listeners. Child patches will add the rest of the API.
In this patch I also correct some improper functional tests.
Change-Id: Id8a2d15c117c54bd45fc8bb76bf71aff1b3c8fe9
Closes-Bug: #1690481
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpeted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Change-Id: I6cde9bb1f815bae91378772626142dd7645188d7
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
