openstack
/
openstack-doc-tools
Code Issues Proposed changes
Tools used by OpenStack Documentation
1,143 Commits 1 Branch 62 Tags 7 MiB
Python 77.5%
Shell 20.3%
XSLT 2.2%
Go to file
Brian Moss 4b85730b3c Skip docutils version that errors on remote images 
Docutils 0.13.1 errors on non-local images.
Skip this release to prevent documentation build problems.

See
http://lists.openstack.org/pipermail/openstack-dev/2016-December/108742.html

Change-Id: If1efc40354979e9e732b1d5654f46c805d499523
 		2016-12-13 16:23:59 +10:00
autogenerate_config_docs Make hooks module import optional 2016-12-02 16:26:56 +00:00
bin PDF support using --pdf option 2016-11-30 01:54:49 +09:00
cleanup Keep py3.X compatibility for urllib 2016-03-14 08:27:45 +05:30
doc/source Gen autogenerate_config_docs/README.rst 2016-11-15 13:29:20 +00:00
os_doc_tools [cli-ref] add project name with service name 2016-11-26 21:04:40 +09:00
releasenotes Properly pass arguments for language building 2016-11-18 15:16:48 +01:00
sitemap Mitaka is an old release now 2016-10-06 14:33:34 +02:00
.gitignore doc-tools unit tests 2016-08-03 07:05:51 +00:00
.gitreview Add .gitreview 2013-12-04 20:44:41 +01:00
.mailmap Add .mailmap 2014-01-07 08:39:30 +01:00
.testr.conf doc-tools unit tests 2016-08-03 07:05:51 +00:00
CONTRIBUTING.rst Note to add 'jinja2' and 'markupsafe' to requirements 2016-03-03 17:54:17 +03:00
HACKING.rst doc-tools unit tests 2016-08-03 07:05:51 +00: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
README.rst Merge "Show team and repo badges on README" 2016-12-09 18:20:27 +00:00
RELEASE_NOTES.rst Typo mistake 2016-11-15 10:20:22 +08:00
doc-test.conf.sample Allow setting of publish directory 2014-02-13 14:07:53 -06:00
openstack-common.conf Remove venv tools 2015-04-29 09:31:58 +02:00
pylintrc Add pylint target for testing 2014-05-19 18:30:07 +02:00
requirements.txt Skip docutils version that errors on remote images 2016-12-13 16:23:59 +10:00
setup.cfg Remove openstack-doc-test 2016-05-19 01:51:03 +00:00
setup.py Updated from global requirements 2015-09-17 12:15:35 +00:00
test-requirements.txt Updated from global requirements 2016-11-02 15:38:34 +00:00
tox.ini Don't include openstack/common in flake8 exclude list 2016-10-31 11:20:21 +07:00

README.rst

Team and repository tags

image

OpenStack Doc Tools

This repository contains tools used by the OpenStack Documentation project.

For more details, see the OpenStack Documentation Contributor Guide.

Prerequisites

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, RHEL 7, and CentOS 7:

$ 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, RHEL 7, and CentOS 7:

$ yum install python-devel libxml2-devel libxslt-devel

On openSUSE:

$ zypper in libxslt-devel

On Ubuntu:

$ apt-get install libxml2-dev libxslt-dev

Regenerating config option tables

See autogenerate_config_docs.