Commit Graph

12 Commits

Author SHA1 Message Date
James E. Blair e244faa159 Correct tagged version docs build
A variable reassignment in conf.py caused errors when we try to build
release versions of docs.  Correct that by swapping the order of use
and assignment.

Change-Id: Idf0116177cdebf9edb248fe8ca16c0bbcc6d8150
2022-03-21 10:23:22 -07:00
James E. Blair e95b146d10 Switch docs theme to versioned RTD
To match change I2870450ffd02f55509fcc1297d050b09deafbfb9 in Zuul.

The default domain is changed to zuul which uncovered a reference
error which is fixed.

Change-Id: I71db35252d018feed41d9e87aa702c6daa61902b
2021-12-16 11:23:30 -08:00
James E. Blair dd551cda96 Normalize sidebar in docs
A new version of the alabaster theme changed how the logo is handled.
Correct that and add previous/next links.  This realigns the docs
with Zuul.

Change-Id: Icd19284e4d3c054a8ad4eeed42e1d93ca87f86bd
2018-11-08 10:00:44 -08:00
Markus Hosch b3ae6e4791 Add list of metrics provided to statsd
This change provides a list of currently available metrics that are
reported by the laucher and the builder.

Change-Id: I51bc38c746cab5374095cc80e77db4534c041119
2018-08-29 08:45:30 +00:00
James E. Blair ddcd08bb61 Add driver interface documentation
Change-Id: Ic1ed5349f74c08fca197e0716ec1e217c60165e7
2018-06-04 11:01:34 -04:00
James E. Blair 3567225294 Add logo to docs
Change-Id: I3bd1993208d08c398e60fedb255abbd5f7444296
2018-05-04 14:48:28 -07:00
Monty Taylor e457f0c6da
Add reno releasenotes support
Do it a little bit differently than OpenStack and just put the
releasenotes into the documentation.

Add an initial release note with no contents so that the build flow and docs
integration can be verified. The note file can be removed later.

Change-Id: Iad16b575e2abbea997b64e3c0e5aa1497b4ff0d2
2018-03-28 15:53:08 -05:00
James E. Blair 94c42e9377 Switch docs to alabaster theme
To match the rest of the Zuul suite.

Change-Id: Ic786c7ea6ce037081b8b9c599c1e451bb4435ddb
2018-03-28 10:18:15 -07:00
Ian Wienand 89790013f3 Consolidate node_list, add generic filter
node_list takes an argument "detail" which adds a rather arbitrary
list of results to the output.  This comes from the command-line,
where we're trying to keep width under a certain length; but doesn't
make as much sense here (especially for json).

For dashboard type applications, replace this with a simple "fields"
parameter which, if set, will only return those fields it sees in the
common text output function.

Note, this purposely doesn't apply to the JSON output, as it expected
client-side filtering is more appropriate there.  We could also add
generic field support to the command-line tools, if considered
worthwhile.

Add some documentation on all the end-points, and add info about these
parameters.

Change-Id: Ifbf1019b77368124961e7aa28dae403cabe50de1
2018-03-01 11:14:03 +11:00
Thanh Ha 3a761d8028 Update Copyright year
Updating conf.py to always pull the current year to avoid needing to update
this in the future, per review feedback.

Change-Id: I1b58210dacf7df92a078ae4a67885b2ed8a1dea1
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
2015-06-02 19:08:07 +00:00
James E. Blair faef2431a7 Finish initial docs
Finish the initial sections defined in the documentation index.
Add sphinxcontrib-programoutput to document command line utils.
Add py27 to the list of default tox targets.

Change-Id: I254534032e0706e410647b023249fe3af4f3a35f
2014-03-31 09:21:56 -07:00
James E. Blair 2b76e3fa55 Add docs
Change-Id: I22ed40b692330ccabe212b75d1d44e54fdd0c97e
2014-01-14 01:00:43 +08:00