Commit Graph

31 Commits

Author SHA1 Message Date
Dmitriy Rabotyagov b0fe7fd14d 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: Ieb0129ffb8964eba380a5d829e4033f19c892451
2022-05-30 16:01:48 +02:00
Zuul 8583a0b021 Merge "Use newer openstackdocstheme and reno versions" 2020-06-05 11:43:13 +00:00
OpenStack Proposal Bot 0d4780794e Updated from OpenStack Ansible Tests
Change-Id: I28eaf78a849320dc6c661ed17d593653e238bd37
2020-06-03 19:11:32 +00:00
Andreas Jaeger e63d039255 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: I661ea2f75fdd0cac7ab57bea378a58e31e204cfe
2020-06-03 20:08:01 +02:00
Andreas Jaeger ac2470c4f5 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: I5fbadb836d7e1533f949601431fc5deacaec64b3
2020-05-20 18:53:04 +02:00
OpenStack Proposal Bot 81560a7997 Updated from OpenStack Ansible Tests
Change-Id: Ife16526448669e0b53f946d9aa0e4747bda5aa9a
2020-05-12 18:05:37 +00:00
OpenStack Proposal Bot 5a3c5a4588 Updated from OpenStack Ansible Tests
Change-Id: Ibb5e60f2fb7eeef3581b74269566e26b79357cff
2020-05-05 13:34:37 +00:00
melissaml 1205049670 Cleanup py27 support
This repo is now testing only with Python
3, so let's make a few cleanups:
- Remove setup.* files, they are not needed for this repo
- Cleanup */source/conf.py to remove noww
  obsolete content.
- Remove install_cmd, move constraints into deps.

Change-Id: I1ae008c4a959cfd6a834ccb05353027c45e3e696
2020-04-27 20:33:48 +02:00
OpenStack Proposal Bot b692b7f3f7 Updated from OpenStack Ansible Tests
Change-Id: Ib9269d1edc2dde264d4bdc956af8d72fb6d74263
2020-04-13 17:55:22 +00:00
OpenStack Proposal Bot 71ebeb123b Updated from OpenStack Ansible Tests
Change-Id: I65049c2bafb101a5faf5738f9e8d6077ddfdf01e
2019-11-21 16:36:58 +00:00
Dmitriy Rabotyagov 0f18a223e8 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: If2171bb5ce432ca4576aad85b2b47ea830b8e6a0
Story: 2006105
2019-10-17 15:37:51 +00:00
OpenStack Proposal Bot 0b3147252d Updated from OpenStack Ansible Tests
Change-Id: I2791656f04bd5c814dd89ca0d39366bc50e77a25
2019-07-30 19:46:16 +00:00
OpenStack Proposal Bot 0888c5386d Updated from OpenStack Ansible Tests
Change-Id: I03fb7dcfae6c860eb640868a053399e08d22a09e
2019-07-20 09:40:54 +00:00
zhangboye 521c503887 Cap sphinx for py2 to match global requirements
Change-Id: I1bbce6b58f55f0715b3005082d891f301ce4b0b3
2019-06-06 18:16:19 +08:00
Mohammed Naser 2dca0097c0 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: I4b4aabb6665567b944fe4da6d0ba834e4769ec68
2019-04-04 04:51:55 +00:00
OpenStack Proposal Bot e503b0807f Updated from global requirements
Change-Id: I380b8f52c460885c986e4ecb9168b453036e63a6
2018-03-15 07:41:07 +00:00
OpenStack Proposal Bot 7ff7a909b5 Updated from global requirements
Change-Id: I2917799108eef6ff31b4294d2336250d819e9b76
2018-03-13 07:17:55 +00:00
OpenStack Proposal Bot 2f74eaee94 Updated from global requirements
Change-Id: I1816eebbfed3dda080f999fb1cd7883bc78e3ab5
2018-03-11 13:55:02 +00:00
ZhongShengping 5c0f04f694 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: I02e496b0b9fd5003ca13ce6d5e83506dd96675f2
2018-03-09 12:01:28 +08:00
Jean-Philippe Evrard 15de93de80 Revert "Remove pip_install dependency"
This reverts commit 0aa4981305.
The repo_server and repo_build shouldn't assume to be configured
by openstack_hosts role yet, because their environment is incomplete.

On top of that, when artifacting will be introduced, these roles could
be running outside the openstack hosts (for example, on deploy nodes).

Change-Id: I47a58a46a695b504646bca8100758decb07cbb98
2017-12-05 17:35:50 +00:00
Jean-Philippe Evrard 0aa4981305 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: Iba21b464fc740639f2653a00d5bac7aff35b9a37
2017-12-05 11:53:26 +00:00
Jesse Pretorius de82c8009d 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: Ifa650996eb87c6519ea3dfc449ebde92a8d7802d
2017-10-17 18:04:21 +01:00
ZhongShengping d8c969cb5b 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: I18403168c19732152f9ba5bd06a64d8884ce92cd
2017-07-03 16:27:39 +08:00
Marc Gariepy 05fee07110 [DOC] add doc page for repo_server role
Change-Id: Idefb279501bf837bcc0920b1e5ffc47467725e5a
2017-05-26 11:04:10 -04:00
ji-xuepeng a2f5012b82 Use https instead of http for git.openstack.org
Trivialfix

Change-Id: I110547e7a41f7d9766f4188c08cc24ddc583ce70
2017-02-06 22:02:23 +08:00
Jean-Philippe Evrard 6eebb4b446 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: I3d61d6f6d3facc4becc3cfbe379f5406d32283a3
2016-12-01 14:03:51 +00:00
Alexandra e4af82dfe4 [DOCS] Update repo server role docs
Change-Id: I59f43bfe10241a69d4fb15d8f652f2241fca728d
2016-08-15 14:01:20 +00:00
Jesse Pretorius 1aa63aa7f4 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: I2789be3c39171c496d7b84ba30a10dd8adb80225
2016-07-26 00:46:02 +01:00
Jesse Pretorius 8686586943 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: I2ff29321fdef8e1b07c55a21f10aa4fd1047edba
2016-07-12 16:55:18 +01:00
Travis Truman 274fc43cfc [DOCS] Cleanup the role docs for consistency and clarity
Change-Id: I709208005ce9b0ad4a4be943213455191fb6e1c3
2016-03-07 17:25:31 -05:00
Kevin Carter 725222afee
first commit
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
2015-12-09 09:25:37 -06:00