Commit Graph

31 Commits

Author SHA1 Message Date
Dmitriy Rabotyagov c845819cae Switch sphinx language to en
With sphinx release of 5.0.0, they changed default for language variable
to 'en' from None. With that current None valuable is not valid and should
not be used.


Change-Id: Ia9f50e5377bda2e141eafa5aa8150024455600e1
2022-05-30 16:01:25 +02:00
Jonathan Rosser dabcc2d98c Fix linter errors
Change-Id: I59d926d302ab2bba33072c5b047dc4d8f9d03d7d
2020-10-02 19:57:34 +01:00
Zuul fe910d9cb2 Merge "Use newer openstackdocstheme and reno versions" 2020-06-05 11:37:19 +00:00
OpenStack Proposal Bot 7cfa134154 Updated from OpenStack Ansible Tests
Change-Id: Ifdc51802ef16df0dedb3812a6d166193d5ba2b52
2020-06-03 19:04:18 +00:00
Andreas Jaeger 35f9499ac2 Use newer openstackdocstheme and reno versions
The sync from https://review.opendev.org/733244 updated to
openstackdocstheme 2.2.1 and reno 3.1.0 versions.

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.

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: Ic9f09ebc84263685f6c0ac63eda363499087f046
2020-06-03 19:13:27 +02:00
Andreas Jaeger 40bc881a31 Update docstheme for style
New version of openstackdocstheme (Victoria+) respects pygments_style.
Since this repo is using now Victoria (master) requirements but has
not branched for Ussuri yet, it uses the new version.

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.

Change-Id: Ib4a46e868b498f24967a8ddf9e877de8fa44cac1
2020-05-20 18:48:28 +02:00
OpenStack Proposal Bot 0aed181b1e Updated from OpenStack Ansible Tests
Change-Id: Ide1779345c1d8fba4ca732cc0f3b3e1dd89f6db6
2020-05-12 18:03:59 +00:00
OpenStack Proposal Bot e778abe290 Updated from OpenStack Ansible Tests
Change-Id: I6b56136544e14ad11a974af67d0b7e4ccc8cae85
2020-05-05 13:32:03 +00:00
Zuul 7f53a9d0ad Merge "Cleanup py27 support" 2020-04-16 23:40:03 +00:00
melissaml c3d416b9c4 Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Cleanup doc/source/conf.py to remove now obsolete content.

Change-Id: I75cbbde0c0f5fa391d76eac3fea06036b3b836f1
2020-04-14 16:39:15 +08:00
OpenStack Proposal Bot fa768be2f7 Updated from OpenStack Ansible Tests
Change-Id: Ic4e45eea4ff275c178b471679703b7a866c8378f
2020-04-13 17:48:57 +00:00
OpenStack Proposal Bot 3bd378f520 Updated from OpenStack Ansible Tests
Change-Id: I1fad84e7c56afe5dee75070c2d13790e06e7c4b1
2019-11-21 16:34:11 +00:00
Dmitriy Rabotyagov e4babdd7c8 PDF Documentation Build tox target
This patch adds a `pdf-docs` tox target that will build
PDF versions of our docs. As per the Train community goal:

  https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Add sphinxcontrib-svg2pdfconverter to doc/requirements.txt
to convert our SVGs.

Change-Id: I26fce963eb6649fd59a8636a80329db15667c73c
Story: 2006105
2019-10-18 16:20:01 +03:00
OpenStack Proposal Bot 6eaddb9daa Updated from OpenStack Ansible Tests
Change-Id: I2db6ad400d743615a18bcd533228e20d5402970a
2019-08-20 03:05:59 +00:00
xuanyandong 61ab51b0a9 Cap sphinx for py2 to match global requirements
Change-Id: I67707b6a971f9834700a1d1a3c19a58db53e1479
2019-05-20 15:54:13 +08:00
Mohammed Naser 405cfcba11 docs: drop sphinxmark
sphinxmark is no longer compatible with the latest release of Sphinx
which is causing all of our documentation jobs to fail.  This patch
removes it as our current usage of openstacktheme for documentation
already provides watermarks for current branch and notices for which
branch the documentation covers.

Change-Id: I3eb2a48a5b2fc567a0b9408af6d2218feee5b9cc
2019-04-04 05:05:17 +00:00
OpenStack Proposal Bot 8c0b6064b6 Updated from global requirements
Change-Id: I876f51cf09b1ee57b55dadfebc732c8e68ba2f85
2018-03-15 07:33:57 +00:00
OpenStack Proposal Bot 41321a9b9c Updated from global requirements
Change-Id: Ic2cdf57887363345c9f54a0016e097a8846e72d8
2018-03-10 13:35:08 +00:00
ZhongShengping cd5d7a03af Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

For more detials information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I4e1dbb40971eba6ec464bc577138947cd4c7ac99
2018-03-09 12:01:26 +08:00
Jean-Philippe Evrard be909c77a8 Remove pip_install dependency
With addition of pip_install on every node, we don't
need to have pip_install as a meta dependency.

Depends-On: If3412bb888ebb854874bbc43eb76bfcb3e4a7868
Depends-On: I79ff70c438b44753be2a93f004ebbc46de0a963d
Change-Id: I30b5f242578804bc6ca9957d8a1177c53b435ebc
2017-12-15 09:51:42 +00:00
Jesse Pretorius beaf7cdff0 Initial OSA zuul v3 role jobs
This patch implements an initial set of jobs intended to match
the current job execution method. It does not intend to improve
how the jobs are executed - only to replicate what is currently
in openstack-infra/openstack-zuul-jobs and provide the platform
to iterate on.

Change-Id: Ifdcbee946cdc838b4b24304dacb1c98c8d78d500
2017-10-17 18:11:13 +01:00
ZhongShengping 55ec0690e0 Fix openstackdocstheme settings
To use openstackdocstheme 1.11.0 properly, this patch fixes
some settings according to follow[0].

[0]https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: Ic13ea49c9bb460d6d03f8920cd12041fb473d8da
2017-07-03 16:15:29 +08:00
ji-xuepeng 2e99c5d88f Use https instead of http for git.openstack.org
Trivialfix

Change-Id: I4e1094e7cef87c3cb094b2447c0bec1cb61ad9bf
2017-02-06 23:15:15 +08:00
Andy McCrae 4e034f093f Update repository with reference to role git location
Change-Id: I16eec2ba2aebcfc16d68aab6a4b4f8c7d0b038db
2016-12-22 14:26:21 +00:00
Jean-Philippe Evrard 897fc5d92e Point roles docs bugs to openstack-ansible LP
Currently when clicking on the small bug in the roles'
docs, we land on openstack-manuals launchpad.

This should solve it.

Change-Id: I1ee63e68b7f47407ad77447d3f464040439a2214
2016-12-01 12:05:54 +00:00
Nish Patwa 625776f4ea [DOCS] Added release-name as a watermark to Docs.
Added a water mark to the role documentation
to make clear to deployers which release they're
working with.

Modified conf.py that adds watermark to the documentation according
to particular branch. If the current branch is master than
watermark is 'Pre-release' and if the current branch is
stable/<release-name> than watermark is <release-name>.

This is a combined implementation based on the following
patches:
- https://review.openstack.org/372565
- https://review.openstack.org/382637
- https://review.openstack.org/384140

Change-Id: Ie451486cfea257691c2112f1900c78188ce549db
2016-10-18 17:12:20 +00:00
Travis Truman 824945c4d7 More detailed os_gnocchi role docs
Also fixed the example playbook to remove references to os_keystone.

Change-Id: I2df8928758f0bb12a3abd295d0ba2944263c55e9
2016-09-26 12:46:29 +00:00
alextricity25 89ab19e011 [DOCS] Move gnocchi configs from developer docs
This commit moves the aodh configs in the developer docs
over to the role. It also cleans up README.rst and index.rst to
support the new three structure for the roles docs

Change-Id: I63bf5a2b742998265782c35582734d1f1d9d1fe8
Signed-off-by: alextricity25 <miguel.cantu@rackspace.com>
2016-08-15 10:36:11 -05:00
Jesse Pretorius bc763b4279 Ensure that doc linting is included in the linters test
The 'docs' tox target executes the doc8 lint test which may result in
failures when testing documentation builds, but OpenStack-CI does not
execute that tox target.

In order to ensure that we catch all standard documentation syntax
errors and prevent them from merging, this patch includes the docs
target in the 'linters' chain of tests.

Fixes for any failures which result from executing this test are also
included in the patch.

Change-Id: Icc2888700616b396c41e20f1b2638de59bc41f60
2016-07-25 21:43:34 +01:00
Jesse Pretorius 3ad51493c5 Update sphinx configuration
This patch updates the sphinx configuration for docs and releasenotes
to make it easier to replicate across repositories and to comply with
pep8 testing without exceptions.

Change-Id: I77ff3c12f6636ecfa646d82a756a2d62fd20057c
2016-07-12 16:52:47 +01:00
Steve Lewis ca23bfd53d Enable docs task
To get the role to pass requisite tasks, a placeholder for the role
docs is provided.

Change-Id: I8ca687405a68103ef6014a5453e8ddf96c8ad599
2016-04-11 16:53:43 -07:00