Commit Graph

37 Commits

Author SHA1 Message Date
Dmitriy Rabotyagov 99f8b02ba0 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: I7148e18813fd9dddd77392b20705e885fb41dd65
2022-05-30 16:01:26 +02:00
Jonathan Rosser 656cb92401 Fix linter errors
Change-Id: I34eb747f78d1955612f320ab7f4909d9e42fecf2
2020-10-01 16:46:13 +01:00
Zuul 212b4dc379 Merge "Use newer openstackdocstheme and reno versions" 2020-06-05 11:39:08 +00:00
OpenStack Proposal Bot 9321b717a9 Updated from OpenStack Ansible Tests
Change-Id: I9d359ffe9e43c91172cfa892a3f075bd076e798a
2020-06-03 19:04:45 +00:00
Andreas Jaeger bcef65191d 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: Ic87ff263a9d3db82db1eda6e87beddb1ce64e38a
2020-06-03 19:14:36 +02:00
Andreas Jaeger de2bd3f94f 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: I36d8c2f46c02ff343ec3a304b7ca347428ad01cf
2020-05-20 18:48:55 +02:00
OpenStack Proposal Bot 2ab1fb0569 Updated from OpenStack Ansible Tests
Change-Id: I968a4fcbd68e24a0ad69edfda0ca0c7d08e2ae96
2020-05-12 18:04:06 +00:00
OpenStack Proposal Bot a650a7fe22 Updated from OpenStack Ansible Tests
Change-Id: I2a96771a353cf0fffaa5e87365cf52ec27d2151d
2020-05-05 13:32:14 +00:00
Zuul 6023c2a7c4 Merge "Updated from OpenStack Ansible Tests" 2020-04-16 13:35:06 +00:00
melissaml f17c60c432 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: I1b8f09b5fce14b53d9538e32b7bd9e7c2615cf24
2020-04-14 16:26:36 +08:00
OpenStack Proposal Bot a58a73dcd8 Updated from OpenStack Ansible Tests
Change-Id: I0fb10874aabba5906c8e0d80bfb0194c1a1ef336
2020-04-13 17:49:25 +00:00
OpenStack Proposal Bot 890801b0be Updated from OpenStack Ansible Tests
Change-Id: Ia2cbf225de9c7792adf334d9bb627d9512e624e3
2019-11-21 16:34:22 +00:00
Dmitriy Rabotyagov b7eaa12dcb 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: I887bd71b3304a9a9078cf60c48b02b871dd8146f
Story: 2006105
2019-10-17 19:48:58 +03:00
OpenStack Proposal Bot adcb328348 Updated from OpenStack Ansible Tests
Change-Id: Iefd32ea8d264ff70623b30e8bce898060b0476cd
2019-07-30 19:39:47 +00:00
OpenStack Proposal Bot 73aa4428b2 Updated from OpenStack Ansible Tests
Change-Id: Ia6a917dbdaea74ecd7c96884df0af6111e44e595
2019-07-20 09:32:50 +00:00
zhangboye 841936b7fd Cap sphinx for py2 to match global requirements
Change-Id: I66cc7f9d99d2fa0edeecdb05dfb9b6a4eef5f988
2019-06-06 17:30:43 +08:00
Mohammed Naser 7479969803 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: I1c5f31eba103847f8eaa9cdb4b37659b52db12f9
2019-04-04 09:08:46 +00:00
chengebj5238 c90eb0b8f1 remove useless whitespaces
Change-Id: Icadd62b0da9206ee0069cb9af81b128a79f86a27
2018-11-24 10:33:29 +08:00
OpenStack Proposal Bot ff4bb8f28e Updated from global requirements
Change-Id: I8d24bb37b1b683a80c7dbede751f24588e346155
2018-03-15 07:34:35 +00:00
melissaml b40093a7a7 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: If3d24a6539426242d156a35a876ea24107fcb8ab
2018-03-12 12:11:09 +08:00
zhang.lei ff7f0d3f0f Remove the deprecated "giturl" option
From openstackdocstheme 1.18.0, valid Git URLs can be retrieved by
openstackdocstheme[1], we do not need giturl option anymore.

[1] https://review.openstack.org/532163

Change-Id: I122d58eb91dbf9f8c262db0950defca86d81ffe6
2018-01-15 02:23:35 +00:00
Jean-Philippe Evrard a77c5809fe 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: I5a953e17787b36b58b831a3d704cd8f51f2078df
2017-12-05 11:52:25 +00:00
Guoqiang Ding 8aef684fdd Update the doc theme
Change-Id: I0ed5cf27ecd43b9374f0fe6970dfa0cf85ad3583
2017-11-24 05:03:58 +00:00
Guoqiang Ding 935b20deb4 Update the doc link
Change-Id: I688f0d54056ef94835b1e9ccf5ed98143863d442
2017-11-13 18:13:56 +08:00
Jesse Pretorius bf53e0b3ee 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: Ia99b5dd4197b6e8cf0d3bc13d5f121250142d452
2017-10-17 18:11:21 +01:00
chenxing 2112f3d9b4 [DOCS] Fix the dead link
backport: ocata

Change-Id: I94bb9d6df636e118d61cea96b12f1f1a91dbca12
Closes-Bug: #1681742
2017-04-11 16:25:59 +00:00
Jimmy McCrory 6eca30751e Provide default horizon_ssl variables
Provide default 'horizon_ssl_protocol' and 'horizon_ssl_cipher_suite'
variables for when this role is run outside of an integrated
OpenStack-Ansible deployment.

Change-Id: I5aee1a06b161329c1d4ea9f92a3e65c485fda641
2017-02-09 17:42:07 -08:00
Cao Xuan Hoang e80da542a0 Use https instead of http for git.openstack.org
Trivialfix

Change-Id: I8e5f49a4cf955206523c6ff49c672ad96dbc1e03
2017-02-06 16:56:30 +07:00
Andy McCrae d70de6a8c4 Update repository with reference to role git location
Change-Id: I8a5b1e2de981068ad0cb5ab34983c0bc1c209935
2016-12-22 14:26:21 +00:00
Jean-Philippe Evrard c277a73ccc 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: I6b4b874485cfd39fa392e8f028591f68218c5534
2016-12-01 12:06:30 +00:00
Nish Patwa d817194c4c [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: I3ed25bdd8cb331e5a6ee08ab9295c6f70cd8f706
2016-10-18 17:10:46 +00:00
Robb Romans f370ce6a84 [DOCS] Add project links to README; fix typos
Change-Id: I048a18106cd0755b58735e0f0b4826b7f3977f7a
2016-08-16 12:48:19 -05:00
Nate Graf f40f7d1308 [DOCS] Move horizon docs to roles
This change moves the horizon config information into the
os_horizon role repo. Moving forward, specific project
configurations are maintained in the appropriate role book.

Change-Id: Ic0b1599aee659f47128aa50f367164b64353556a
2016-08-12 19:26:54 +00:00
Jesse Pretorius 4dbde0e418 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: I3b14ec1524a0f32705b85835fe3d1eb4b181fc56
2016-07-26 07:38:09 +01:00
Jesse Pretorius 87b7057aab 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: Ie362d100b887e80982bafffd0714400adaf1139d
2016-07-12 16:53:04 +01:00
Travis Truman 5ce73596ba [DOCS] Cleanup the role docs for consistency and clarity
Utilizing RST includes to reduce duplication of documentation
effort. All contents of the Ansible defaults/main.yml are
now included in the documentation directly.

Change-Id: I84822047d5570853e2530f698dc53ff13220090e
2016-03-10 08:55:29 -05:00
Travis Truman 8c21de8612 Implement base configuration for independent repository
Change-Id: I2226f825d2d5132331496ce2cf8aeda65d605dff
2016-03-02 09:39:02 -05:00