This patch enables building .pdf documentation using new 'pdf-docs'
tox environment. The newly created tox environment creates latex
source codes using sphinx-build and then builds the pdf
documentation using make.
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Disable openstackdocs_auto_name to use 'project' variable as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
Tempest defines its scope as only what is accessible through the
various REST APIs. Some cloud features cannot be properly tested when
using only the REST API. The whitebox-tempest-plugin is a Tempest
plugin whose scope explicitly requires peeking behind the curtain. In
other words, if a feature or behavior can be fully tested using only a
REST API, such a test does not belong in whitebox-tempest-plugin. On
the other hand, if fully testing a feature or behavior requires
accessing the control plane like a human operator or admin would, such
a test belongs in whitebox-tempest plugin.
* Update to newer openstackdocstheme, remove settings from conf.py that
are default now.
* Remove unused autodoc extension.
* Remove unused and obsolete settings from setup.cfg
This commit updates sphinx library and treats warnings as errors. We
often miss doc warnings. So this commit makes them errors to build a
better html document.
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.
We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.
We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.
Signed-off-by: Doug Hellmann <email@example.com>
This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.
Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are
See the python3-first goal document for details:
While reading the README.rst to get ready to submit a spec
and I saw that Repository structure layout and the Expected
workflow section of the README.rst could be updated to
support the Repository directory structure.
This spec describes a proposed enhancement for testing multiple
policy actions for API tests that call API endpoints that enforce
Specifies blueprint rbac-testing-multiple-policies
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
The 0.13.1 release breaks some documentation jobs when it tries to build
docs with remote images. This has been reported upstream. The version
matches the supported docutils versions for sphinx.
Since Iab676ae9bf95ee858c5e748c9579f7778e87bd77 , the negative test
framework has been removed. So this spec is never implemented.
In addition, we deleted never-implemented specs on the commit
I86331ac279b6a9cdb94ed4c43e5b0c41697e6a7d . So this patch removes
the corresponding spec.
list-plugins is done with If28311bc2e8d29a97ee46d7d73edba2a93aed7ce
centralized-workspaces is done with I9595e3ba809e457951a0ffdf4b15f641f2fec4f4
client-manager-refactor is done with I6a4845edb95031243bca12a8d03c60cf18528212
Since I41b42e02ff17f2d98862ddb11f137580abadafde , the stress test is
marked as deprecated in Tempest, and this development has stopped
1 year and 9 months ago.
So it is nice to remove this spec for the cleanup.