Fedora 31 was retired and the image is gone from mirrors.
heat-cfntools have been dropped from fedora images, disable
the test till that's resolved.
Also makes grenade job non-voting, till this is backported
to stable/victoria.
Change-Id: Id869f83a46454897c2fe7a532eebfa2863befe5e
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I4ebb6e663471a7096bd9d0e1a90d8114d1875546
Six is in use to help us to keep support for python 2.7.
Since the ussuri cycle we decide to remove the python 2.7
support so we can go ahead and also remove six usage from
the python code.
Review process and help
-----------------------
Removing six introduce a lot of changes and an huge amount of modified files
To simplify reviews we decided to split changes into several patches to avoid
painful reviews and avoid mistakes.
To review this patch you can use the six documentation [1] to obtain help and
understand choices.
Additional informations
-----------------------
Changes related to 'six.b(data)' [2]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
six.b [2] encode the given datas in latin-1 in python3 so I did the same
things in this patch.
Latin-1 is equal to iso-8859-1 [3].
This encoding is the default encoding [4] of certain descriptive HTTP
headers.
I suggest to keep latin-1 for the moment and to move to another encoding
in a follow-up patch if needed to move to most powerful encoding (utf8).
HTML4 support utf8 charset and utf8 is the default charset for HTML5 [5].
Note that this commit message is autogenerated and not necesserly contains
changes related to 'six.b'
[1] https://six.readthedocs.io/
[2] https://six.readthedocs.io/#six.b
[3] https://docs.python.org/3/library/codecs.html#standard-encodings
[4] https://www.w3schools.com/charsets/ref_html_8859.asp
[5] https://www.w3schools.com/html/html_charset.asp
Patch 1 of a serie of 28 patches
Change-Id: Ia310a58ffdc688302b32d57a6bef6b1b8f5d9950
Sphinx is now warning if the glossary is not properly capitalized, lower
case the entries so that they can be referenced more easily.
Task: 39421
Story: 2007558
Change-Id: Ic0c636db20f6d2fe5b1ad7782d937d01657bb091
This feature of openstackdocstheme means that we'll always link to the
corresponding branch of another project (i.e. latest links to latest,
but train links to train, &c.)
https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper
Change-Id: If94115f87af3689413405f3283be7fb197fab058
1. Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.
2. Add whitelist_externals to fix the warning
[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045
Change-Id: I47683ab1313981a8202afe6b3fe1779d40340452
This change provides the necessary modifications to enable
building of pdf documentation. The resources.py extension
required modification to:
- prevent attributes from being rendered as stray \items
outside of a list environment
- prevent update policies from being rendered as stray
\items outside of a list environment
- remove the 'Note:' admonition around the 'Not implemented'
message when it applies to a sub-property, such as a list.
The admonition was not rendered as a list item, causing the
build to fail due to an empty list.
Change-Id: Id4e533430600b5ff03fd63cdc09b9a00741b8e4e
openstack-tox-docs is failing with below error.
Warning, treated as error:
html_static_path entry '_static' does not exist
Change-Id: Ic6f5a463f0ec95537ebea0855ebd71d4e4ed5df4
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: Ie6b9bdc0cdb6939903920806334f71aa6133c12b
The description of installing heat on Debian system in
the document is incomplete, so it needs to be updated
Change-Id: I2794bf0b53374a8c2da55f5cbc7b599220b29c33
Links are of the form
.. _name: http://
If you use "<http://>" instead, the "<" and ">" will be part of the URL
and break, see the link on https://docs.openstack.org/heat/latest/admin/auth-model.html
Fix this.
Change-Id: I76b8dc215352d1dffa9b36c8f00b2aecbcf6400d
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.
Note that redirects will be set up as well but let's point now to the
new location.
For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html
Change-Id: I69a41aa850c87e92bf5c3e7fed32e0e961a3c6d3
Since the Keystone v2 API was removed in Queens, the Keystone setup
documentation recommends using the same port (5000) for admin access as
for regular internal/public access.
Change-Id: Ic49acc5b57122fded11b5d17f8b51bf54dd29674
Task: 33508
Add doc for multi-clouds support in template guide.
Also remove redundant credential information in multi-clouds
integration test.
Change-Id: I76c6427b7bbdac2af3b7f01aff1b0541e56b3653
Story: #2002126
Task: #19808
The auth_uri parameter of keystonemiddleware was renamed to
'www_authenticate_uri'[1], so update the documentation accordingly.
[1] https://review.opendev.org/508522
Change-Id: Ie3967064493fafb68df8e56f3d3dc097fbd19cc4
There's a regression[0] in bandit 1.6.0 which causes bandit to stop
respecting excluded directories, and our tests throw a bunch of
violations. Blacklist this version, but allow newer versions as there is
already a pull request[1] to fix it, and I expect it will be included in
the next release.
Also fix the requirements job which was broken by
https://review.opendev.org/657890 adding a cap on Sphinx on Python 2.
[0] https://github.com/PyCQA/bandit/issues/488
[1] https://github.com/PyCQA/bandit/pull/489
Change-Id: Ieabcd4e8c5e5354125a63e89b9b60931c760858a
Our cgit instance will be going away and opendev.org is the new
preferred URL for browsing our git repos. Redirects will exist for the
foreseeable future, but it's more efficient to just go directly to the
new locations.
Change-Id: Ic5fa1a8436f57836ad37b752a0cca1cd4f3a21a7