openstack/openstack-doc-tools
Code Issues Proposed changes
Tools used by OpenStack Documentation
1,067 Commits 1 Branch 63 Tags 7 MiB
Python 77.5%
Shell 20.3%
XSLT 2.2%
f2c24dd564
Go to file
Percila f2c24dd564 doc-tools unit tests 
Renamed sitemap file to avoid module name conflict
when importing at the sitemap unittest

Added py.test tox environment

Change-Id: I94480e374b29802414b62591a51c04ecd804905e
Closes-Bug: #1387716
2016-07-26 18:23:50 +03:00
.cache/v/cache doc-tools unit tests 2016-07-26 18:23:50 +03:00
autogenerate_config_docs Merge "[config-ref] skip options marked as disable" 2016-07-26 13:13:21 +00:00
bin [cli-reference] remove oslo.log installation 2016-06-09 22:50:14 +09:00
cleanup Keep py3.X compatibility for urllib 2016-03-14 08:27:45 +05:30
doc/source Remove openstack-doc-test 2016-05-19 01:51:03 +00:00
os_doc_tools doc-tools unit tests 2016-07-26 18:23:50 +03:00
releasenotes Remove openstack-doc-test 2016-05-19 01:51:03 +00:00
sitemap doc-tools unit tests 2016-07-26 18:23:50 +03:00
.gitignore Remove build_environment from .gitignore 2016-05-02 21:30:46 +02:00
.gitreview Add .gitreview 2013-12-04 20:44:41 +01:00
.mailmap Add .mailmap 2014-01-07 08:39:30 +01:00
CONTRIBUTING.rst Note to add 'jinja2' and 'markupsafe' to requirements 2016-03-03 17:54:17 +03:00
doc-test.conf.sample Allow setting of publish directory 2014-02-13 14:07:53 -06:00
HACKING.rst doc-tools unit tests 2016-07-26 18:23:50 +03: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 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
README.rst Remove openstack-doc-test 2016-05-19 01:51:03 +00:00
RELEASE_NOTES.rst Update RELEASE Notes 2015-11-15 09:56:56 +01:00
requirements.txt Updated from global requirements 2016-07-09 03:15:41 +00: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 doc-tools unit tests 2016-07-26 18:23:50 +03:00
tox.ini doc-tools unit tests 2016-07-26 18:23:50 +03: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

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