Tools used by OpenStack Documentation
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul 2b275421b0 Merge "Remove openstack-jsoncheck and openstack-indexpage" 1 month ago
bin Cleanup doc-tools-check-languages 2 months ago
doc/source Merge "Remove some commented obsolete lines" 2 months ago
os_doc_tools Remove openstack-jsoncheck and openstack-indexpage 2 months ago
releasenotes Remove openstack-jsoncheck and openstack-indexpage 2 months ago
sitemap Update docs building 2 months ago
test Remove openstack-jsoncheck and openstack-indexpage 2 months ago
.gitignore Switch to stestr 1 year ago
.gitreview OpenDev Migration Patch 6 months ago
.mailmap Add .mailmap 5 years ago
.stestr.conf Switch to stestr 1 year ago
.zuul.yaml Add Python 3 Train unit tests 3 months ago
CONTRIBUTING.rst Note to add 'jinja2' and 'markupsafe' to requirements 3 years ago
HACKING.rst Fix URLs 2 years ago
LICENSE Add LICENSE and README.rst 5 years ago
README.rst Replace git.openstack.org URLs with opendev.org URLs 5 months ago
RELEASE_NOTES.rst Fix URLs 2 years ago
bindep.txt add lower-constraints job 1 year ago
lower-constraints.txt Update docs building 2 months ago
requirements.txt Update docs building 2 months ago
setup.cfg Remove openstack-jsoncheck and openstack-indexpage 2 months ago
setup.py Updated from global requirements 2 years ago
test-requirements.txt Update docs building 2 months ago
tox.ini Update docs building 2 months ago

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