658f29cc2e
Build the index.html file also when only RST files changed. Change-Id: I50a59fad6a5ca5deda8c6aad6ad2667f9b16321a |
||
|---|---|---|
| autogenerate_config_docs | ||
| bin | ||
| build_environment | ||
| cleanup | ||
| doc/source | ||
| os_doc_tools | ||
| sitemap | ||
| tools | ||
| .gitignore | ||
| .gitreview | ||
| .mailmap | ||
| doc-test.conf.sample | ||
| HACKING.rst | ||
| LICENSE | ||
| MANIFEST.in | ||
| openstack-common.conf | ||
| pylintrc | ||
| README.rst | ||
| RELEASE_NOTES.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
OpenStack Doc Tools
This repository contains tools used by the OpenStack Documentation project.
For more details, see the OpenStack Documentation wiki page.
Prerequisites
Apache Maven must be installed to build the documentation.
To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:
apt-get install mavenOn Fedora:
yum install mavenYou 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-lxmlOn openSUSE:
zypper in python-lxmlOn Ubuntu:
apt-get install python-lxmlFor building from source, install the dependencies of lxml.
On Fedora:
yum install python-devel libxml2-devel libxslt-develOn openSUSE:
zypper in libxslt-develOn Ubuntu:
apt-get install libxml2-dev libxslt-devUpdating 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.
Publishing of books
If you run the openstack-doc-test --check-build, it will
copy all the books to the directory publish-docs in the
top-level directory of your repository.
By default, it outputs a directory with the same name as the directory where the pom.xml file lives in, such as admin-guide-cloud. You can also check the output of the build job for the name.
Some books need special treatment and there are three options you can
set in the file doc-test.conf:
book- the name of a book that needs special treatmenttarget_dir- the path of subdirectory starting attargetthat is the root for publishingpublish_dir- a new name to publish a book under
As an example, to publish the compute-api version 2 in the directory
publish-docs/api/openstack-compute/2, use:
book = openstack-compute-api-2
target_dir = target/docbkx/webhelp/api/openstack-compute/2
publish_dir = api/openstack-compute/2Note that these options can be specified multiple times and should
always be used this way. You do not need to set publish_dir
but if you set it, you need to use it every time.
Also note that these are optional settings, the logic in the tool is sufficient for many of the books.
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 this page:
Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at:
http://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub: