This updates our thread extension and tox command for docs builds to use
the available number of cores to multithread the docs build. This can
speed things up significantly.
Depends-on: https://review.opendev.org/741026
Change-Id: I1ba656390094b4e1c6d3fb7bb3028eadb11c4d08
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
In package building process, there might be build environments
becoming more popular without Python 2.x being installed, with
other words /usr/bin/python does not exist. The existing script
uses a shebang of "env python", which works fine inside a virtualenv
but not outside. The easy solution is to just call the script
with the same python interpreter we're being called with.
Change-Id: Id91996545f7f75c1c62cea34e240b9655b8ff3af
A lot of our config option reference documentation was out of date, with
deprecated and removed options and changed defaults. This changes the
"Additional options" configuration reference to use the config-table
directive so the published docs stay in sync with changes in the code.
Closes-bug: #1814910
Change-Id: Ib891435dc69eb795ea6d4d0fb6626259e95cf27f
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Sphinx 1.6 deprecated using the application object to perform logging
and it will be removed in the upcoming 2.0 release. This updates our
extensions to use the recommended sphinx.util.logging instead.
Change-Id: I3b44e096c62a081e195ea22bc953d1752d7ff4b7
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Some driver docs have different options in the table for
different configuration types. This adds the ability to
skip named properties to be able to control which options
get included in the table output.
Change-Id: I3c6e31bc11eaec5326314b6eb7e0184429f347bf
In the past we had used an openstack-manuals tool to manually generate
config option tables that would then be included into driver config
documentation.
With the move of documentation in-tree and the deprecation and removal
of that tool, we have ended up with options that are no longer being
updated when drivers change, or maintainers are left manually updating
the existing tables.
This addes a sphinx extension to use a new config-table directive to
automatically pull in config options from the source so we no longer
need to perform any manual action to pick up changes.
Change-Id: I625fb96229001c326ed2400155e2d067279a400e
Now that sphinxcontrib.apidoc is available, we should get rid of
the custom code we have for generating this information ourselves.
This also cleans up some really stale docs that are no longer
needed.
Change-Id: Iaa9fecc2478326b45b67a2cfd98de5f93f537efe
Source code should be licensed under the Apache 2.0 license.
All source files should have the licensing header.
Change-Id: I67df47560d87182265ec4fa973bddaf356829fc1
We have tox -e gendriverlist that outputs an RST-ish report of all drivers
in the tree. This output can be used in the docs build to automatically
publish the list of drivers to make it easier to find officially supported
drivers.
This effectively removes the existing drivers.html that was generated prior
that did not actually contain any useful information.
Change-Id: I8de78723af76aabcc976733ac4b248db0b8ca16f
We had an extension for pulling out todo information from our docs. This
doesn't appear to have ever really been used though. Only a couple todo items
were published to the Cinder documentation, and the two published appear to
be extremely old.
Since this isn't really used and could just cause confusion, removing this
from the index page and removing the sphinx extension used to generate it.
Change-Id: I8993633538a5ee1687c4721bce3c520e8fb4ccfd
Add "from six.moves import range" to replace the builtin range()
function with six.moves.range() to always create an iterator, instead of
creating a temporary list.
Replace "xrange" with "range".
Don't add the import for ranges of 1024 items or less.
Blueprint cinder-python3
Change-Id: If618b4e810e444f7eb6592bb2398805e9d14d548
In python 3 print statement is not supported, so we should use
only print() functions.
Fixes bug 1226943
Change-Id: I7b2e4d52fe9050f6a67c44e4cc1237a15ea90b23
Fix some pep8 issues in doc/ext/cinder_todo.py and
doc/source/conf.py and make the code looks pretty.
Change-Id: Ie164bc7328507e20b0ab5993ba97eaadbd74bf63
The docs job wasn't working because of an un-renamed file.
Coverage wasn't running in jenkins with the xml output file.
Remove the .cache.bundle support that we're moving away from.
Change-Id: I1140baa53dee8b14ac4d1f8549425a0fdd7a8425
