openstack/openstack-doc-tools
Code Issues Proposed changes
Tools used by OpenStack Documentation
1,336 Commits 1 Branch 63 Tags 7 MiB
Python 77.5%
Shell 20.3%
XSLT 2.2%
d14b09d516
Go to file
Stephen Finucane d14b09d516 Update CI to use unversioned jobs template 
As part of the migration of this project to the independent release
model, we failed to notice that the job template was still tied to a
specific release. We've now introduced a new unversioned job template,
'openstack-python3-jobs' [1], which was can and should use. Do this.

[1] https://review.opendev.org/c/openstack/openstack-zuul-jobs/+/833286/

Change-Id: If74666468cebc05e3089d0ea3fb864ffe7f35f1b
Depends-On: https://review.opendev.org/c/openstack/openstack-zuul-jobs/+/833286/
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2022-03-15 15:06:47 +00:00
bin Cleanup doc-tools-check-languages 2019-08-15 20:35:40 +02:00
doc/source Adding pre-commit 2020-09-15 15:05:13 +02:00
os_doc_tools Remove openstack-jsoncheck and openstack-indexpage 2019-08-19 13:04:13 +00:00
releasenotes Switch to newer openstackdocstheme and reno versions 2020-05-29 12:45:49 +02:00
sitemap Adding pre-commit 2020-09-15 15:05:13 +02:00
test Merge "Use unittest.mock instead of mock" 2020-08-17 16:07:38 +00:00
.gitignore Switch to stestr 2018-07-11 13:10:05 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:34:21 +00:00
.mailmap Add .mailmap 2014-01-07 08:39:30 +01:00
.pre-commit-config.yaml Move flake8 as a pre-commit local target. 2021-03-23 13:14:08 +01:00
.stestr.conf Switch to stestr 2018-07-11 13:10:05 +07:00
.zuul.yaml Update CI to use unversioned jobs template 2022-03-15 15:06:47 +00:00
bindep.txt add lower-constraints job 2018-03-25 09:16:50 -04:00
CONTRIBUTING.rst setup.cfg: Cleanup and update some urls to latest 2019-10-22 11:22:44 +08:00
HACKING.rst setup.cfg: Cleanup and update some urls to latest 2019-10-22 11:22:44 +08:00
LICENSE Add LICENSE and README.rst 2013-12-10 15:45:37 +01:00
lower-constraints.txt Merge "Use unittest.mock instead of mock" 2020-08-17 16:07:38 +00:00
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-04-23 03:16:36 +00:00
RELEASE_NOTES.rst Fix URLs 2017-09-07 19:55:58 +02:00
requirements.txt [goal] Migrate testing to ubuntu focal 2020-08-04 00:33:17 +00:00
setup.cfg Cleanup py27 support 2020-04-05 10:14:14 +02:00
setup.py Cleanup py27 support 2020-04-05 10:14:14 +02:00
test-requirements.txt Adding pre-commit 2020-09-15 15:05:13 +02:00
tox.ini Merge "Use py3 as the default runtime for tox" 2021-01-21 14:57:40 +00:00

README.rst

Team and repository tags

image

OpenStack Doc Tools

This repository contains tools used by the OpenStack Documentation project.

For more details, see the OpenStack Documentation Contributor Guide.

Prerequisites

You need to have Python 2.7 installed for using the tools.

This package needs a few external dependencies including lxml. If you do not have lxml installed, you can either install python-lxml or have it installed automatically and build from sources. To build lxml from sources, you need a C compiler and the xml and xslt development packages installed.

To install python-lxml, execute the following based on your distribution.

On Fedora, RHEL 7, and CentOS 7:

$ yum install python-lxml

On openSUSE:

$ zypper in python-lxml

On Ubuntu:

$ apt-get install python-lxml

For building from source, install the dependencies of lxml.

On Fedora, RHEL 7, and CentOS 7:

$ yum install python-devel libxml2-devel libxslt-devel

On openSUSE:

$ zypper in libxslt-devel

On Ubuntu:

$ apt-get install libxml2-dev libxslt-dev