Tools used by OpenStack Documentation
Go to file
Andreas Jaeger 0f4e5291db Avoid tox_install.sh for constraints support
Follow https://review.openstack.org/#/c/508061 to remove
tools/tox_install.sh, we can build without it.

Change-Id: Ia27fb4f8a4da8d5ae2755b54c3274402362ae521
2017-11-30 21:30:15 +01:00
bin Remove the 'openstack-auto-commands' tool 2017-10-04 11:47:58 +01:00
doc/source Remove 'autogenerate_config_docs' 2017-10-04 11:47:56 +01:00
os_doc_tools Remove the 'openstack-auto-commands' tool 2017-10-04 11:47:58 +01:00
releasenotes Remove setting of version/release from releasenotes 2017-11-16 21:24:31 +01:00
sitemap Fix to use "." to source script files 2017-08-29 02:18:04 +08:00
test Change priorities for sitemap 2017-07-28 20:30:06 +02:00
.gitignore Update sitemap tests 2017-04-29 10:36:27 +10:00
.gitreview Add .gitreview 2013-12-04 20:44:41 +01:00
.mailmap Add .mailmap 2014-01-07 08:39:30 +01:00
.testr.conf doc-tools unit tests 2016-08-03 07:05:51 +00:00
CONTRIBUTING.rst Note to add 'jinja2' and 'markupsafe' to requirements 2016-03-03 17:54:17 +03:00
HACKING.rst Fix URLs 2017-09-07 19:55:58 +02:00
LICENSE Add LICENSE and README.rst 2013-12-10 15:45:37 +01:00
README.rst Remove 'autogenerate_config_docs' 2017-10-04 11:47:56 +01:00
RELEASE_NOTES.rst Fix URLs 2017-09-07 19:55:58 +02:00
bindep.txt Add openssl libs to bindep 2017-06-18 10:58:56 +02:00
requirements.txt Updated from global requirements 2017-11-29 09:12:50 +00:00
setup.cfg Remove "cleanup" tools 2017-10-04 11:48:00 +01:00
setup.py Updated from global requirements 2017-03-02 11:52:39 +00:00
test-requirements.txt Updated from global requirements 2017-09-16 23:21:07 +00:00
tox.ini Avoid tox_install.sh for constraints support 2017-11-30 21:30:15 +01: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