openstack
/
openstack-doc-tools
Code Issues Proposed changes
Tools used by OpenStack Documentation
189 Commits 1 Branch 62 Tags 6.9 MiB
Python 77.5%
Shell 20.3%
XSLT 2.2%
Go to file
Andreas Jaeger f0c6cd4871 Add parameter --ignore-dir 
This allows to ignore directories, e.g.
ignore in compute api the incubation and v1 dirs with:

openstack-doc-test --check-build --api-site \
  --ignore-dir=incubation --ignore-dir=openstack-compute-api-1.0

Change-Id: I6bad41543ed2269217a2ed36fcd947b83707daf2
 		2014-01-07 09:39:58 +01:00
autogenerate-config-docs Require hacking for additional checks 2014-01-03 11:25:56 +01:00
bin Make markdown-docbook.sh more robust 2013-12-28 16:14:08 +01:00
cleanup Require hacking for additional checks 2014-01-03 11:25:56 +01:00
doc/source Add parameter --ignore-dir 2014-01-07 09:39:58 +01:00
os_doc_tools Add parameter --ignore-dir 2014-01-07 09:39:58 +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
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 Package markdown-docbook.sh 2013-12-28 16:08:44 +01:00
README.rst Merge "Document lxml requirement" 2014-01-04 09:22:49 +00:00
openstack-common.conf Import venv setup from oslo-incubator 2014-01-01 11:11:29 +01:00
requirements.txt Rework repository to make it an installable python package 2013-12-14 22:53:18 +01:00
setup.cfg Use sphinx for documentation of openstack-doc-tools 2014-01-03 12:19:40 +01:00
setup.py Rework repository to make it an installable python package 2013-12-14 22:53:18 +01:00
test-requirements.txt Use sphinx for documentation of openstack-doc-tools 2014-01-03 12:19:40 +01:00
tox.ini Require hacking for additional checks 2014-01-03 11:25:56 +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

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