openstack/openstack-doc-tools
Code Issues Proposed changes
Tools used by OpenStack Documentation
651 Commits 1 Branch 63 Tags 7 MiB
Python 77.5%
Shell 20.3%
XSLT 2.2%
d3f4a25d43
Go to file
Gauvain Pocentek d3f4a25d43 autohelp-wrapper: reorganise project dependencies 
This patch moves the explicit dependencies for projects in their own
requirement file.

Install a bunch of new neutron dependencies (drivers moved to their own
dependencies).

Change-Id: I8cab9861a5546f270499f626b06e44ad0185477d
2015-04-23 19:01:50 +02:00
autogenerate_config_docs autohelp-wrapper: reorganise project dependencies 2015-04-23 19:01:50 +02:00
bin Merge "Handle SPECIAL_BOOKs in doc-tools-check-languages" 2015-03-13 07:40:25 +00:00
build_environment [build-environment] add repository ha-guide and update README file 2014-12-25 12:51:08 +01:00
cleanup Use yaml.safe_load() instead of yaml.load() 2015-02-24 14:05:19 +01:00
doc/source Run doc8 as part of pep8 test 2014-08-17 06:51:54 +02:00
os_doc_tools Capitalize project names correctly 2015-04-14 21:10:26 +02:00
sitemap Update sitemap generator 2015-02-13 23:46:09 -06:00
tools Rename Openstack to OpenStack 2014-02-13 16:28:39 +08:00
.gitignore A virtual building and testing environment using Vagrant 2014-08-11 18:46:00 +02:00
.gitreview Add .gitreview 2013-12-04 20:44:41 +01:00
.mailmap Add .mailmap 2014-01-07 08:39:30 +01:00
doc-test.conf.sample Allow setting of publish directory 2014-02-13 14:07:53 -06:00
HACKING.rst Add HACKING.rst 2014-01-02 12:13:33 +01: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
openstack-common.conf Import module log and needed dependencies from oslo-incubator 2014-08-11 15:42:52 +02:00
pylintrc Add pylint target for testing 2014-05-19 18:30:07 +02:00
README.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:37 +00:00
RELEASE_NOTES.rst Update RELEASE Notes for 0.24 release 2015-04-09 20:14:37 +02:00
requirements.txt Updated from global requirements 2015-03-21 00:15:01 +00:00
setup.cfg Add wrapper script to update CLI references 2015-03-12 15:53:20 +01:00
setup.py Updated from global requirements 2014-04-30 02:43:55 +00:00
test-requirements.txt Update to hacking 0.10 2015-01-13 09:04:27 +01:00
tox.ini Cap maximal cyclomatic complexity 2014-10-20 14:53:21 +02: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

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.

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:

http://docs.openstack.org/infra/manual/developers.html

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:

https://bugs.launchpad.net/openstack-manuals