openstack
/
openstack-doc-tools
Code Issues Proposed changes
Tools used by OpenStack Documentation
217 Commits 1 Branch 62 Tags 6.9 MiB
Python 77.5%
Shell 20.3%
XSLT 2.2%
Go to file
Andreas Jaeger c586091172 Add tool to document cli tools 
Call "os_doc_tools/commands.py" nova to generate a file
section_cli_nova_commands.xml with the command line options.

Allows generation of all supported clients with --all command.
The tool gets installed as: openstack-auto-commands

blueprint os-user-doc
Change-Id: Ie4b200818bd585d3fce0b27f0639ad03069b3b7b
 		2014-01-22 20:52:56 +01:00
autogenerate_config_docs Rename autogenerate-config-docs to autogenerate_config_docs 2014-01-21 17:00:22 +01:00
bin Fix path in generatedocbook 2014-01-13 21:04:40 +08:00
cleanup Require hacking for additional checks 2014-01-03 11:25:56 +01:00
doc/source Add option --exceptions-file 2014-01-20 10:11:20 +01:00
os_doc_tools Add tool to document cli tools 2014-01-22 20:52:56 +01:00
sitemap Updates sitemap.xml for havana release links 2013-10-21 18:46:55 -05:00
tools Import venv setup from oslo-incubator 2014-01-01 11:11:29 +01:00
.gitignore Import venv setup from oslo-incubator 2014-01-01 11:11:29 +01:00
.gitreview Add .gitreview 2013-12-04 20:44:41 +01:00
.mailmap Add .mailmap 2014-01-07 08:39:30 +01: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 Do not download RNG Schema, instead use local copies 2014-01-07 09:05:26 +01:00
README.rst Add tool to document cli tools 2014-01-22 20:52:56 +01:00
openstack-common.conf Import venv setup from oslo-incubator 2014-01-01 11:11:29 +01:00
requirements.txt Sync with global requirements 2014-01-16 09:30:40 +01:00
setup.cfg Add tool to document cli tools 2014-01-22 20:52:56 +01:00
setup.py Rework repository to make it an installable python package 2013-12-14 22:53:18 +01:00
test-requirements.txt Minor cleanup of test-requirements and tox 2014-01-18 16:19:38 +01:00
tox.ini Rename autogenerate-config-docs to autogenerate_config_docs 2014-01-21 17:00:22 +01: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 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.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

  • Fixes path for automated translation toolchain to fix lp:bug 1216153
  • Validates .xsd .xsl and.xjb files in addition to .xml
  • Fixes validation of WADL files to validate properly against XML schema

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:

http://wiki.openstack.org/HowToContribute

Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at:

http://wiki.openstack.org/GerritWorkflow

Pull requests submitted through GitHub will be ignored.

Bugs should be filed on Launchpad, not GitHub:

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