openstack/openstack-doc-tools
Code Issues Proposed changes
Tools used by OpenStack Documentation
235 Commits 1 Branch 63 Tags 7 MiB
Python 77.5%
Shell 20.3%
XSLT 2.2%
6fd213cc46
Go to file
Jeremy Stanley 6fd213cc46 Remove tox locale overrides 
* tox.ini: The LANG, LANGUAGE and LC_ALL environment overrides were
introduced originally during the testr migration in an attempt to be
conservative about the possibility that locale settings in the
calling environment could cause consistency problems for test runs.
In actuality, this should be unnecessary and any place where it does
cause issues ought to be considered an actual bug. Also, having
these in the configuration actively causes older pip to have
problems with non-ASCII content in some package metadata files under
Python 3, so drop it now.

Change-Id: Ia8ca284a41ea12fdcda53b5e113e80583c0ea3fa
Closes-Bug: #1277495
2014-02-10 03:06:47 +00:00
autogenerate_config_docs Improve docbook format for cli commands 2014-01-31 19:48:09 +01:00
bin Fix gating of identity and image apis 2014-02-08 21:28:06 +01:00
cleanup Require hacking for additional checks 2014-01-03 11:25:56 +01:00
doc/source Generate a log file for each built book 2014-02-08 22:18:56 +01:00
os_doc_tools Generate a log file for each built book 2014-02-08 22:18: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
doc-test.conf.sample Copy all generated books to common path 2014-02-03 22:45:46 +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 Avoid putting autogenerate_config_docs/.gitignore into sdist 2014-02-06 11:42:36 +01:00
openstack-common.conf Import venv setup from oslo-incubator 2014-01-01 11:11:29 +01:00
README.rst Generate a log file for each built book 2014-02-08 22:18:56 +01:00
requirements.txt Sync with global requirements 2014-01-16 09:30:40 +01:00
setup.cfg Honor install prefix 2014-02-06 11:34:45 +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 Remove tox locale overrides 2014-02-10 03:06:47 +00: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.7

  • Fix building of identity-api and image-api books.
  • Add option --debug.
  • Generate log file for each build.

0.6

  • Fix python packaging bugs that prevented sitepackages usage and installed .gitignore in packages

0.5

  • Test that resources in wadl files have an xml:id (lp:bug 1275007).
  • Improve formatting of python command line clients (lp:bug 1274699).
  • Copy all generated books to directory publish-docs in the git top-level (lp:blueprint draft-docs-on-docs-draft).
  • Requires now a config file in top-level git directory named doc-test.conf.
  • Allow building of translated manuals, these need to be setup first with "generatedocbook -l LANGUAGE -b BOOK".

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