Commit Graph

34 Commits

Author SHA1 Message Date
Dmitriy Rabotyagov 37422a7e3d 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: I3f0403e3d74f105ea567ee411349791eae3a470c
2022-05-30 16:01:16 +02:00
Jonathan Rosser c27ee13684 Fix linter errors
Also remove centos-7 jobs which are no longer supported

Change-Id: I82dc5ca09e436d5703cf8a4bb59ea7d2c3120411
2020-10-05 08:09:23 +00:00
Zuul f0b2048243 Merge "Use newer openstackdocstheme and reno versions" 2020-06-05 11:01:30 +00:00
OpenStack Proposal Bot be08d7497a Updated from OpenStack Ansible Tests
Change-Id: Ie26c0a4e8b4c2799002b5c297490dd3f624c2c5c
2020-06-03 19:00:11 +00:00
Andreas Jaeger 231d6c7d2f 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: Ic5b77991ef4fe356771041fc71c2930744b23d4e
2020-06-03 19:01:54 +02:00
Andreas Jaeger 17d9a842fa 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: Icb7ee6ec2b567e98d0a1145bfae10d205fb91a25
2020-05-20 18:45:05 +02:00
OpenStack Proposal Bot eb7bae3ad6 Updated from OpenStack Ansible Tests
Change-Id: I07f65d8ca5d7171f5044acc954632b85e58f7b73
2020-05-12 18:02:58 +00:00
OpenStack Proposal Bot ee07912fdf Updated from OpenStack Ansible Tests
Change-Id: I68e7938de7d0b4586de858788b746b6640b2083c
2020-05-05 13:30:32 +00:00
Zuul a013d60783 Merge "Cleanup py27 support" 2020-04-28 13:06:01 +00:00
melissaml 301b5cd5fd Cleanup py27 support
This repo is now testing only with Python
3, so let's make a few cleanups:
- Remove setup.* files, those are not needed
  for this repo
- Cleanup */source/conf.py to remove now
  obsolete content.
- Remove install_cmd from tox.ini, the default is fine;
  move constraints into deps, cleanup

Change-Id: I6dae70865bac5abb0d394e93c2a854e74c2689d7
2020-04-27 20:17:51 +02:00
OpenStack Proposal Bot 5df6885733 Updated from OpenStack Ansible Tests
Change-Id: If673d576df277fe1d730ba339d97fb304dd3684d
2020-04-13 17:45:07 +00:00
OpenStack Proposal Bot 94c2eb757f Updated from OpenStack Ansible Tests
Change-Id: Iaf182b16e9129199f3a32b645c37c59f4e683bb1
2019-11-21 16:32:36 +00:00
Dmitriy Rabotyagov 7ac02f39f4 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: Iabe812ee7e25838132fa2b1e0372df7bb0b0bd0d
Story: 2006105
2019-10-17 19:30:21 +03:00
OpenStack Proposal Bot ac0ea6bf1b Updated from OpenStack Ansible Tests
Change-Id: Ic2baf362b53d2c1e71ef98a712be33bf086ac566
2019-07-30 19:35:10 +00:00
OpenStack Proposal Bot 1d49153eca Updated from OpenStack Ansible Tests
Change-Id: I27878c1f8ea5a17f2fcc194929ae4030ba047271
2019-07-20 09:27:02 +00:00
zhangboye 5a4aa122b7 Cap sphinx for py2 to match global requirements
Change-Id: I9547d25a5be95a9cc2e57431b8a497cbfab5dc98
2019-06-06 17:41:03 +08:00
Mohammed Naser 61ff4ffcbf 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: I1735c255b3717dc8e82ce97c23c8ac188ff28128
2019-04-04 05:15:04 +00:00
OpenStack Proposal Bot beeb8573f6 Updated from global requirements
Change-Id: I1da560616a0883a51f0252ff31641a535d147819
2018-03-15 07:30:04 +00:00
OpenStack Proposal Bot 865c4b657e Updated from global requirements
Change-Id: Ibf282e513d1e3025750261bcb763f5b395d63a6b
2018-03-13 07:11:38 +00:00
OpenStack Proposal Bot 7f33e14ed7 Updated from global requirements
Change-Id: Iada9a6f9947c8983b3b4d84cd98b794504a7d10c
2018-03-11 13:49:56 +00:00
ZhongShengping 6eb5907be5 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: I0e329f1414787aaedc59835600a3c972bb817f9c
2018-03-09 12:01:25 +08:00
Jesse Pretorius ed224c54a6 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: If86f31a6ff188c57c5981dcf9eddc26af7101b25
2017-10-17 22:17:20 +01:00
ZhongShengping 7554679038 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: I136e996d09e775e7974ce3e0efd830fb8497ca76
2017-07-03 16:11:56 +08:00
ji-xuepeng b11955b357 Use https instead of http for git.openstack.org
Trivialfix

Change-Id: I1bc740ed4b77f1061b02e2bab87626675628956e
2017-02-06 21:18:34 +08:00
Andy McCrae 9caf6f4d90 Update repository with reference to role git location
Change-Id: I3290364dcc4745d48a934e3ee3f69ac3cd239d86
2016-12-22 14:26:20 +00:00
Jean-Philippe Evrard 5743239a68 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: Ie200be10d9f9cc3f75bf315a90b6140eef3bd138
2016-12-01 15:08:27 +00:00
Nish Patwa 83c3e9b182 [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: Idff273dc3bc5f874ee695825c4c97cce0541e9bb
2016-10-18 17:25:39 +00:00
Robb Romans b06ca2f2ab [DOCS] Move playbook example to separate file
Change-Id: I9551748692140100ede69fa5fa0ad61609743109
2016-08-12 09:29:13 -05:00
Jesse Pretorius 5332e624da 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: I9849dc55c2c093ae0bc2ee8527907fa233a0a861
2016-07-25 22:48:25 +01:00
Jesse Pretorius fb3afe5978 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: I9ad5b8912ce67c4c1b7f722dd0cc280ccd4a8c2e
2016-07-12 16:51:07 +01:00
Travis Truman 3d41e00e9a DOC - Adopting the common role documentation pattern
As discussed during the Newton design summit, we
agreed to adopt the role documentation pattern laid
out in the os_keystone role

Change-Id: Ifbf6c90481a6b40781341dce2b1992a6baebe633
2016-06-07 10:44:42 -04:00
Kevin Carter 0c16334a2c
updated for lxc-container-create for multi-distro support
This change updates the lxc-container-create role to build lxc containers
using the download template. The build supports ubuntu 14.04/16.04 and
RedHat/CentOS 7 using the multi-distro framework.

This change is incorporating updates built into the lxc_hosts role. Once
merged this should unblock all work geared toward multi-distro support and
testing. The testing structure has been updated to match what is being done
in other roles.

A new file was created "manual-tests.rc" which assists in manual testing
by exporting the needed environment variables to run the role tests without
requiring everything to run through tox which has undesirable side-effects
when running tests that span multiple roles.

Change-Id: Iee304dd026e0865e0444259d2132122233d90f5f
Depends-On: Ie13be2322d28178760481c59805101d6aeef4f36
Co-Authored-By: Jesse Pretorius <jesse.pretorius@rackspace.co.uk>
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
2016-05-03 15:15:34 -05:00
Kevin Carter c3405ef941
Updates for typos
This change updates a few things that were missed when the role
was cut over.

Change-Id: I0f4670cc7d11fde5907a0856c1de40b39ebf3de7
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
2015-12-08 16:50:45 -06:00
Kevin Carter 8f8cf55edd
IRR for lxc_container_create
The change moves the role out from the main repo lxc_container_create
repository and into its own standalone repository.

Items within this change:
  * The role has been updated to ensure it runs standalone.
  * Tests added to the role within tox.
  * Functional tests added to the role that can either be run
    via the run_tests.sh script or using tox.
  * dev requirements have been updated for testing usecases.
  * Docs added to both the README.rst file as well as the docs
    folder.

Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
2015-11-03 08:00:45 -06:00