Tools used by OpenStack Documentation
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Brian Moss d3bc42483a Update sitemap tests 2 years ago
autogenerate_config_docs [autohelp] Return options as dicts instead of lists 2 years ago
bin [cli-ref] add API version for cinder explicitly 2 years ago
cleanup Keep py3.X compatibility for urllib 3 years ago
doc/source Update sitemap tests 2 years ago
os_doc_tools Update sitemap tests 2 years ago
releasenotes Remove swift tooling 2 years ago
sitemap Update sitemap tests 2 years ago
test Update sitemap tests 2 years ago
tools Add Constraints support 2 years ago
.gitignore Update sitemap tests 2 years ago
.gitreview Add .gitreview 6 years ago
.mailmap Add .mailmap 5 years ago
.testr.conf doc-tools unit tests 3 years ago
CONTRIBUTING.rst Note to add 'jinja2' and 'markupsafe' to requirements 3 years ago
HACKING.rst doc-tools unit tests 3 years ago
LICENSE Add LICENSE and README.rst 6 years ago
MANIFEST.in Move release notes into a separate file 5 years ago
README.rst Update sitemap tests 2 years ago
RELEASE_NOTES.rst Typo fix: occured => occurred 2 years ago
doc-test.conf.sample Allow setting of publish directory 5 years ago
openstack-common.conf Remove venv tools 4 years ago
pylintrc Add pylint target for testing 5 years ago
requirements.txt Updated from global requirements 2 years ago
setup.cfg Remove support for py33 2 years ago
setup.py Updated from global requirements 2 years ago
test-requirements.txt Update sitemap tests 2 years ago
tox.ini Update sitemap tests 2 years ago

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.