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.
OpenStack Proposal Bot 6a568b9aaf Updated from global requirements 1 year ago
bin Update ZUUL variables for Zuul v3 1 year ago
doc/source Remove 'autogenerate_config_docs' 1 year ago
os_doc_tools Remove the 'openstack-auto-commands' tool 1 year ago
releasenotes Remove setting of version/release from releasenotes 1 year ago
sitemap Fix to use "." to source script files 1 year ago
test Change priorities for sitemap 1 year ago
.gitignore Update sitemap tests 2 years ago
.gitreview Add .gitreview 5 years ago
.mailmap Add .mailmap 5 years ago
.testr.conf doc-tools unit tests 2 years ago
CONTRIBUTING.rst Note to add 'jinja2' and 'markupsafe' to requirements 3 years ago
HACKING.rst Fix URLs 1 year ago
LICENSE Add LICENSE and README.rst 5 years ago
README.rst Remove 'autogenerate_config_docs' 1 year ago
RELEASE_NOTES.rst Fix URLs 1 year ago
bindep.txt Add openssl libs to bindep 1 year ago
requirements.txt Updated from global requirements 1 year ago
setup.cfg Remove "cleanup" tools 1 year ago Updated from global requirements 2 years ago
test-requirements.txt Updated from global requirements 1 year ago
tox.ini Avoid for constraints support 1 year ago


Team and repository tags


OpenStack Doc Tools

This repository contains tools used by the OpenStack Documentation project.

For more details, see the OpenStack Documentation Contributor Guide.


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