54aa873505
This is needed for publishing in the future: This is so that we can create a list of directories to ignore when we rsync documentation builds to a publishing site. Some builds are published as subdirectories underneath the results of superior builds. This allows those superior builds to be rsynced without removing the other builds that were published under them. http://specs.openstack.org/openstack-infra/infra-specs/specs/doc-publishing.html Change-Id: Ic8773caebecafa87b10c1ad4612bde6b1513b667 |
||
---|---|---|
autogenerate_config_docs | ||
bin | ||
cleanup | ||
doc/source | ||
os_doc_tools | ||
releasenotes | ||
sitemap | ||
.gitignore | ||
.gitreview | ||
.mailmap | ||
.testr.conf | ||
CONTRIBUTING.rst | ||
HACKING.rst | ||
LICENSE | ||
MANIFEST.in | ||
README.rst | ||
RELEASE_NOTES.rst | ||
doc-test.conf.sample | ||
openstack-common.conf | ||
pylintrc | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
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
- License: Apache License, Version 2.0
- Source: http://git.openstack.org/cgit/openstack/openstack-doc-tools
- Bugs: http://bugs.launchpad.net/openstack-manuals