RETIRED, further work has moved to Debian project infrastructure

Go to file

Jenkins f66660ab5a Merge "[diff_branches] remove the broken --format option"		2017-06-02 05:03:13 +00:00
autogenerate_config_docs	[diff_branches] remove the broken --format option	2017-06-01 22:37:37 +02:00
bin	[cli-ref] add API version for cinder explicitly	2017-03-22 00:08:06 +09:00
cleanup	Keep py3.X compatibility for urllib	2016-03-14 08:27:45 +05:30
doc/source	Merge "Update docs theme configuration"	2017-05-01 12:14:48 +00:00
os_doc_tools	Update sitemap tests	2017-04-29 10:36:27 +10:00
releasenotes	Add release-note about docs	2017-05-01 17:25:12 +02:00
sitemap	Update sitemap tests	2017-04-29 10:36:27 +10:00
test	Update sitemap tests	2017-04-29 10:36:27 +10:00
tools	Add Constraints support	2016-12-13 23:05:47 +01: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
doc-test.conf.sample	Allow setting of publish directory	2014-02-13 14:07:53 -06:00
HACKING.rst	doc-tools unit tests	2016-08-03 07:05:51 +00:00
LICENSE	Add LICENSE and README.rst	2013-12-10 15:45:37 +01:00
MANIFEST.in	Move release notes into a separate file	2014-07-28 22:04:02 +02:00
openstack-common.conf	Remove venv tools	2015-04-29 09:31:58 +02:00
pylintrc	Add pylint target for testing	2014-05-19 18:30:07 +02:00
README.rst	Update sitemap tests	2017-04-29 10:36:27 +10:00
RELEASE_NOTES.rst	Update RELEASE_NOTES	2017-05-01 10:13:41 +02:00
requirements.txt	Updated from global requirements	2017-06-02 02:34:12 +00:00
setup.cfg	Remove support for py33	2017-01-23 14:08:47 +07:00
setup.py	Updated from global requirements	2017-03-02 11:52:39 +00:00
test-requirements.txt	Update sitemap tests	2017-04-29 10:36:27 +10:00
tox.ini	Update docs theme configuration	2017-04-30 09:30:39 +02:00

README.rst

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.

License: Apache License, Version 2.0
Source: https://git.openstack.org/cgit/openstack/openstack-doc-tools
Bugs: https://bugs.launchpad.net/openstack-doc-tools

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

Regenerating config option tables

See autogenerate_config_docs.