Commit Graph

32 Commits

Author SHA1 Message Date
Dmitriy Rabotyagov 854b8a2b1f 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: I2de7c07f52d75740e9a1050ef3f1e19e88aeb808
2022-05-30 16:01:39 +02:00
Jonathan Rosser 2aece27a47 Fix linter errors
Change-Id: If04b1dc1c268d4866086fe5280273ee49057f9bd
2020-10-01 16:55:00 +01:00
Zuul 639ef054b6 Merge "Use newer openstackdocstheme and reno versions" 2020-06-05 11:45:03 +00:00
OpenStack Proposal Bot 9eb71111d5 Updated from OpenStack Ansible Tests
Change-Id: I3829d3cb34a35128a9465d4017ecb37b469dbea6
2020-06-03 19:08:39 +00:00
Andreas Jaeger c78d271638 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: Ib7f76f49d8679991b2deb22aff0d7878bc1e2ce0
2020-06-03 20:04:38 +02:00
Andreas Jaeger 34659610bc 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: I2963b474efb08ac4fb619830673b5b1e12a89389
2020-05-20 18:51:17 +02:00
OpenStack Proposal Bot d692cadd47 Updated from OpenStack Ansible Tests
Change-Id: Ibd192b705545bb5fd70f2107779e748c095330fb
2020-05-12 18:04:57 +00:00
OpenStack Proposal Bot dbce50bde0 Updated from OpenStack Ansible Tests
Change-Id: Idb94cea3a5afe05baf4a4248fde2aba3d107fa44
2020-05-05 13:33:36 +00:00
melissaml ad5a658b54 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: I7b01050c13a960ad603a2d223530ed43e551a274
2020-04-14 18:38:31 +08:00
OpenStack Proposal Bot 367fb6945d Updated from OpenStack Ansible Tests
Change-Id: I80da2e75b6cc90cd7e4b1ea6ecc68ad0f8feb9b9
2020-04-13 17:52:48 +00:00
OpenStack Proposal Bot 3b3c4dfea8 Updated from OpenStack Ansible Tests
Change-Id: Id7ac11ae1817483312fb385d575578d97960daea
2019-11-21 16:35:47 +00:00
Dmitriy Rabotyagov 2e31110da3 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: I6ae29f8a01529bd4786547a11b73171e008dfd0b
Story: 2006105
2019-10-18 18:28:36 +03:00
OpenStack Proposal Bot 08bae09cb9 Updated from OpenStack Ansible Tests
Change-Id: I97e13961b284461f61da702a31a4da914d190b06
2019-07-30 19:43:21 +00:00
OpenStack Proposal Bot f5ceb57e33 Updated from OpenStack Ansible Tests
Change-Id: I3c4b2fab82eb6047b4ce37119c1af18120234e43
2019-07-20 09:37:14 +00:00
Zuul 5d72aee916 Merge "Replace git.openstack.org URLs with opendev.org URLs" 2019-07-16 17:34:48 +00:00
melissaml c53e631763 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I73a8bb8682d3daf027bc3b532912c852121afbae
2019-07-11 06:04:51 +08:00
zhangboye 14eda01099 Cap sphinx for py2 to match global requirements
Change-Id: I2942e7393fd2d0d3762a82600329188ee36d60f1
2019-06-07 10:05:15 +08:00
Mohammed Naser a81e822ece 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: I9f33bb52b164d4a7e034423f7356bd6c3684f92d
2019-04-04 05:11:04 +00:00
OpenStack Proposal Bot 5d6b057b8b Updated from global requirements
Change-Id: Idcd0e5e17521d780eac6a1e04770bdbb1f38d527
2018-03-15 07:37:43 +00:00
OpenStack Proposal Bot d148b6c66b Updated from global requirements
Change-Id: I7dedd4f2bfd2bef5bc65ae0d1af17247150d445b
2018-03-10 13:36:58 +00:00
ZhongShengping 17c9afe0c2 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: I5f62438a1003a07364aee5380be004b2a3b94fab
2018-03-09 12:01:27 +08:00
Jean-Philippe Evrard a3035d9372 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: I5ce8640cfb86af34694a0b8e308a5aa95cea8eaa
2017-12-05 11:55:59 +00:00
Jesse Pretorius 22b34fbf86 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: I3103b032d8847eeb044d87e0ed7950c9078e18a1
2017-10-17 20:52:06 +00:00
ZhongShengping e45463109d 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: Ibe45903eba62be86ed0678ce3479cd2826930b50
2017-07-03 16:45:15 +08:00
gecong1973 852b4299b0 Use https instead of http for git.openstack.org
TrivialFix

Change-Id: Icc03742921f7a177ac7e7d0faf33d0f7916ff9e5
2017-02-06 11:11:33 +08:00
Andy McCrae 4b451fc394 Update repository with reference to role git location
Change-Id: Ib81c4efdcbab7becfab3a7c1f9f7ba63163a5cd5
2016-12-22 14:26:22 +00:00
Jean-Philippe Evrard 8fec76369e 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: Ie373bc77f3e51ff81c9115546d8dd37935c59ca2
2016-12-01 14:40:41 +00:00
Nish Patwa 178cf88759 [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: I9996d6cb33fc87faf95af99e0db483c593bcf69b
2016-10-18 17:03:29 +00:00
Travis Truman 3d6a643eac [DOCS] - Use new documentation tree structure
Changes the rally role doc tree to the new structure
we are adopting for each role.

Change-Id: I8776c6953b65753d9bf54b13f3f7a282f3ce8df0
2016-08-22 16:07:06 -05:00
Jesse Pretorius 254418abe8 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: Iacff67847b0708a5d41ab3e1accf59f40326497d
2016-07-26 07:38:59 +01:00
Jesse Pretorius e46ba1c3a3 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: I3a80b33771e4142dae589b7f6fbf0f94255cabc8
2016-07-12 16:53:56 +01:00
Travis Truman 329318acfa Adding testing 2016-03-25 11:28:16 -04:00