674 Commits

Author SHA1 Message Date
Matthias Runge
6a9c35d898 Move testing to Fedora 33
Now that the gate is unblocked, we can also test F33 for gating purposes
here.

Change-Id: Ie1c9075623d85b27aaf1ac67a3063e219726bc6f
2021-01-19 16:38:43 +00:00
Matthias Runge
61e53c4eca Replace Fedora test image with F32
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
2020-12-04 12:18:59 +05:30
Zuul
5eec3e4bd0 Merge "Modify 'if' Macro to allow optional properties" 2020-11-02 17:46:26 +00:00
Zuul
cba6d9b03a Merge "Add template version 2021-04-16 for Wallaby" 2020-11-02 17:45:07 +00:00
Zane Bitter
71a9c3d690 Modify 'if' Macro to allow optional properties
Change-Id: I931d88e79fc077d12fc9bd39009061ffe87f1262
Story: 2007388
Task: 38973
2020-10-27 16:59:30 -04:00
Zane Bitter
674a62ae9b Add template version 2021-04-16 for Wallaby
Change-Id: I57047682cfa82ba6ca4affff54fab5216e9ba51c
Story: 2007388
2020-10-27 16:55:38 -04:00
Zane Bitter
9e6c3212b9 Add U + V release codenames for docs generation
This makes for nicer output in the resource types docs.

Change-Id: I5c7b0e7454df0c5dd33efb03c08d15ea231bf530
2020-08-12 10:06:35 -04:00
Andreas Jaeger
b3e7c590f0 Switch to newer openstackdocstheme and reno versions
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
2020-05-21 09:43:55 +02:00
Rabi Mishra
f18a676792 Use Fedora 31 for tests
Change-Id: Ia45e957bb24f5596a5ef16271f71ba8b77df9e42
2020-05-12 11:28:31 +05:30
Hervé Beraud
991e967846 Remove six and python 2.7 full support
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
2020-04-22 12:23:44 +02:00
Andreas Jaeger
9e84032750 Fix doc building with Sphinx 3
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
2020-04-15 12:29:04 +02:00
ricolin
c739be7645 Migrate doc path to contributor
Migrate document contributing and developing_guides to
contributor.

Change-Id: I6308992451c8d65fb7c1b99c73b801bbf6152999
2020-02-22 14:16:50 +08:00
Zuul
88528fb7de Merge "Docs: Fix links broken since Train release" 2020-02-22 06:14:00 +00:00
Zuul
a94b683978 Merge "Docs: Fix link broken since Stein release" 2020-02-22 06:13:58 +00:00
Zuul
db67ce1cdb Merge "Docs: use extrefs to link to other projects' docs" 2020-02-22 06:11:50 +00:00
Andreas Jaeger
97db901658 [ussuri][goal] Finish dropping python 2.7 support
OpenStack is dropping the py2.7 support in ussuri cycle.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

This change cleans up:
* remove old requirements
* remove universal wheel building, we don't need this for py3
* cleanup setup.py
* tox.ini: move basepython around; remove install_command since the
  default is fine and constraints should be in deps; add
  ignore_basepython_conflict

Change-Id: Ife0a696ca62be21d3d93c5d8279a412578f62697
2020-02-06 18:58:12 +01:00
Zane Bitter
40ec766568 Docs: Fix links broken since Train release
Change-Id: Iccd1185c697d3c44c887ee69ef403c8c4c9ef6fb
2020-01-23 12:31:27 -05:00
Zane Bitter
18f59964a0 Docs: Fix link broken since Stein release
Change-Id: I3c9bdfe1bc40e6b96335041928aed275d1eb4958
2020-01-23 12:30:38 -05:00
Zane Bitter
dd70d9244d Docs: use extrefs to link to other projects' docs
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
2020-01-23 12:30:34 -05:00
Zuul
c0a5eaf6b9 Merge "Replace git.openstack.org URLs with opendev.org URLs" 2020-01-09 19:07:39 +00:00
Zuul
f860a7307d Merge "Remove the unnecessary jeos building docs" 2020-01-09 17:39:58 +00:00
zhulingjie
087efe1a96 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I76d9981c4d0f437f72a442f14c2b2f60e00b4dfc
2019-12-23 19:04:56 +00:00
chao liu
247eaa4cf3 Remove the unnecessary jeos building docs
Since the docs below already describe how to build heat jeos, the jeos
building docs is no longer needed.

https://docs.openstack.org/heat/latest/template_guide/
software_deployment.html#software-deployment-resources

https://github.com/openstack/heat-templates/tree/master/hot/
software-config/elements

Change-Id: I5a9f68419a050e1a6215d6b5a1c18e5182e0734b
2019-12-23 13:16:09 -05:00
huangtianhua
6c48f4d03b Update the default implementation of _show_resource
Give the latest implementation of Resource's
_show_resource in pluginguide.rst.

Change-Id: I21162d68398980d1a7b2cfae9bfe051855b39269
2019-12-23 17:15:03 +00:00
Zuul
28ce9f3ad4 Merge "tox: Keeping going with docs" 2019-12-20 05:26:43 +00:00
Zuul
21aed54e5c Merge "Use resource description as default description property" 2019-12-19 12:33:48 +00:00
Zuul
55d7b1327a Merge "PDF documentation build" 2019-12-05 06:20:45 +00:00
caoyuan
eb10545b37 tox: Keeping going with docs
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
2019-11-01 11:30:12 +08:00
Zuul
9f3ea0a63e Merge "Update osprofiler about doc" 2019-10-22 02:38:22 +00:00
matthew-fuller
debff05779 PDF documentation build
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
2019-10-01 08:57:22 -07:00
Zuul
0d564d933e Merge "Update devel info: mailing list" 2019-09-27 19:41:06 +00:00
Zuul
784863f12a Merge "Bump the openstackdocstheme extension to 1.20" 2019-09-25 15:50:37 +00:00
Rabi Mishra
f3efe1de29 Ensure _static exists with placeholder
openstack-tox-docs is failing with below error.

Warning, treated as error:
html_static_path entry '_static' does not exist

Change-Id: Ic6f5a463f0ec95537ebea0855ebd71d4e4ed5df4
2019-08-23 09:25:22 +05:30
Zuul
14d1c36de0 Merge "Update Debian Installation Document" 2019-08-13 16:27:46 +00:00
Zuul
e6e2470b7d Merge "Fix broken RST link" 2019-08-06 21:46:54 +00:00
pengyuesheng
14f2678c48 Bump the openstackdocstheme extension to 1.20
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
2019-08-01 09:43:50 +08:00
Zuul
70d7a1bc86 Merge "Blacklist sphinx 2.1.0 (autodoc bug)" 2019-07-31 13:49:37 +00:00
pengyuesheng
e08a81100f Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: Ifdfe8dc074f7e3bb4ea0df4cd78e95842fc322ab
2019-07-30 16:53:08 +08:00
zengjia
160947debf Update Debian Installation Document
The description of installing heat on Debian system in
the document is incomplete, so it needs to be updated

Change-Id: I2794bf0b53374a8c2da55f5cbc7b599220b29c33
2019-07-29 19:54:22 +08:00
Andreas Jaeger
b31af77e1d Fix broken RST link
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
2019-07-26 09:20:50 +02:00
Zuul
6ad9d3f43a Merge "Update install docs for Keystone v3" 2019-07-24 12:56:52 +00:00
Andreas Jaeger
208cdfea39 Update api-ref location
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
2019-07-22 18:55:34 +02:00
Zuul
8aea1ca7b2 Merge "Add doc for multi-clouds support" 2019-06-28 15:16:02 +00:00
Zane Bitter
629d1042c8 Update install docs for Keystone v3
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
2019-06-27 14:20:22 -04:00
ricolin
fdb5e892bf Add doc for multi-clouds support
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
2019-06-25 07:37:27 +00:00
Colleen Murphy
28dd8117ba Update keystone_authtoken config reference
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
2019-06-12 15:08:39 -07:00
gao.hanxiang
011fa22c42 Blacklist bandit 1.6.0 and cap Sphinx on Python2
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
2019-05-14 16:50:24 -04:00
ricolin
203bce9cd7 Switch to use opendev.org
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
2019-04-22 09:36:50 +05:30
ricolin
8e41757bf7 Add code name for Train 13.0.0 in document
Change-Id: I4464db4b70bfa334fc9f0b497192f4165650d21d
2019-03-22 12:45:55 +08:00
ricolin
af9c2e4baa Add Code name for Stein 12.0.0 in document
Change-Id: Ieb5d2204b283d63dbf534752a40cb63231b267bf
2019-03-22 12:44:51 +08:00