Prerequisites

To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:

apt-get install maven

On Fedora:

yum install maven3

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 openSUSE:

zypper in libxslt-devel

On Ubuntu:

apt-get install libxml2-dev libxslt-dev

Updating RNG schema files

The repository contains in the directory os_doc_tools/resources a
local copy of some RNG schema files so that they do not need to be
downloaded each time for validation of XML and WADL files.

Please see the README.txt in the directory for details on where
these files come from.

Release notes

0.5

Test that resources in wadl files have an xml:id (lp:bug 1275007).

Improve formatting of python command line clients (lp:bug 1274699).

Copy all generated books to directory publish-docs in the git
top-level (lp:blueprint draft-docs-on-docs-draft).

Requires now a config file in top-level git directory named
doc-test.conf.

Allow building of translated manuals, these need to be setup first
with “generatedocbook -l LANGUAGE -b BOOK”.

0.4

New option –exceptions-file to pass list of files to ignore
completely.

Major improvements for automatic generation of option tables.

New tool openstack-auto-commands to document python
command line clients.

0.3

0.2

Enables local copies of RNG schema for validation.

Enables ignoring directories when checking.

0.1

Initial release.

Contributing

Our community welcomes all people interested in open source cloud computing,
and encourages you to join the OpenStack Foundation.
The best way to get involved with the community is to talk with others online
or at a meetup and offer contributions through our processes, the OpenStack
wiki, blogs, or on IRC at #openstack
on irc.freenode.net.

We welcome all types of contributions, from blueprint designs to documentation
to testing to deployment scripts.

If you would like to contribute to the development,
you must follow the steps in the “If you’re a developer, start here”
section of this page: