Tools used by OpenStack Documentation
Go to file
Andreas Jaeger fe586291ff Remove openstack-doc-test
openstack-doc-test is used for building of DocBook XML files. For index
page generation openstack-indexpage can be used.

Remove openstack-doc-test together with all support files.

Change-Id: I5589bc634e1f630f79b3d6e8bffee939c5300bf2
2016-05-19 01:51:03 +00:00
autogenerate_config_docs use environment variables for GITPROJ and GITBASE 2016-04-25 03:03:18 +08:00
bin Remove DocBook XML translation support 2016-05-02 12:57:34 +02:00
cleanup Keep py3.X compatibility for urllib 2016-03-14 08:27:45 +05:30
doc/source Remove openstack-doc-test 2016-05-19 01:51:03 +00:00
os_doc_tools Remove openstack-doc-test 2016-05-19 01:51:03 +00:00
releasenotes Remove openstack-doc-test 2016-05-19 01:51:03 +00:00
sitemap [sitemap] mark liberty as an old release 2016-04-05 12:59:58 +02:00
.gitignore [cli-ref] Added support for 'help' and 'version' 2016-04-19 04:55:08 +00:00
.gitreview Add .gitreview 2013-12-04 20:44:41 +01:00
.mailmap Add .mailmap 2014-01-07 08:39:30 +01:00
CONTRIBUTING.rst Note to add 'jinja2' and 'markupsafe' to requirements 2016-03-03 17:54:17 +03:00
HACKING.rst Remove openstack-doc-test 2016-05-19 01:51:03 +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
README.rst Remove openstack-doc-test 2016-05-19 01:51:03 +00:00
RELEASE_NOTES.rst Update RELEASE Notes 2015-11-15 09:56:56 +01:00
doc-test.conf.sample Allow setting of publish directory 2014-02-13 14:07:53 -06: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
requirements.txt Updated from global requirements 2016-04-30 18:07:21 +00:00
setup.cfg Remove openstack-doc-test 2016-05-19 01:51:03 +00:00
setup.py Updated from global requirements 2015-09-17 12:15:35 +00:00
test-requirements.txt Add docs environment 2016-04-29 23:30:43 -05:00
tox.ini Add docs environment 2016-04-29 23:30:43 -05:00

README.rst

OpenStack Doc Tools

This repository contains tools used by the OpenStack Documentation project.

For more details, see the OpenStack Documentation wiki page.

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:

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:

yum install python-devel libxml2-devel libxslt-devel

On openSUSE:

zypper in libxslt-devel

On Ubuntu:

apt-get install libxml2-dev libxslt-dev