Tools for OpenStack Documentation
Project description
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 maven
On Fedora:
yum install maven
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
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.
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 treatment
target_dir - the path of subdirectory starting at target that is the root for publishing
publish_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/2
Note 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.
License: Apache License, Version 2.0
Source: http://git.openstack.org/cgit/openstack/openstack-doc-tools
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for openstack-doc-tools-0.29.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6dba8b13fb85e5ab5c74b9160b548a10a583ba910276f8211c501375c85a6929 |
|
| MD5 | 28ace13d765b25845f947163bf921988 |
|
| BLAKE2b-256 | ae0fc1476e439a9029cff60cf60bef86c254bc41a1bdc6c4f0e7f5c7bc2b2827 |
Hashes for openstack_doc_tools-0.29.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5591dd6f72c114f815f193bff99a071da5791b1f28b43767d1b9095837c30511 |
|
| MD5 | 3db9c8a886beed7ba6118fa196178c00 |
|
| BLAKE2b-256 | e929803fda05dae4974a4f12535973dc5692d7e716ebb39221488648f5e63c2e |
