Tools used by OpenStack Documentation
Go to file
Nguyen Hung Phuong 1298e765d1 fix tox python3 overrides
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.

We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.

We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.

Change-Id: I483632acf5a68075bbf200ffb172f945e5294cf8
2018-07-09 13:41:19 +07:00
bin [lang] Fixes PUBLISH_DIR for api-quick-start 2018-04-19 10:47:17 +09: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 Clean imports in code 2018-02-21 13:38:16 +07: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
.zuul.yaml add lower-constraints job 2018-03-25 09:16:50 -04: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 Update links in README 2018-03-03 13:04:13 +08:00
RELEASE_NOTES.rst Fix URLs 2017-09-07 19:55:58 +02:00
bindep.txt add lower-constraints job 2018-03-25 09:16:50 -04:00
lower-constraints.txt add lower-constraints job 2018-03-25 09:16:50 -04:00
requirements.txt Merge "Remove unused oslo.config requirement" 2018-03-21 11:30:51 +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 2018-01-24 01:22:22 +00:00
tox.ini fix tox python3 overrides 2018-07-09 13:41:19 +07: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