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.
Zuul 2b275421b0 Merge "Remove openstack-jsoncheck and openstack-indexpage" 1 mese fa
bin Cleanup doc-tools-check-languages 1 mese fa
doc/source Merge "Remove some commented obsolete lines" 1 mese fa
os_doc_tools Remove openstack-jsoncheck and openstack-indexpage 1 mese fa
releasenotes Remove openstack-jsoncheck and openstack-indexpage 1 mese fa
sitemap Update docs building 1 mese fa
test Remove openstack-jsoncheck and openstack-indexpage 1 mese fa
.gitignore Switch to stestr 1 anno fa
.gitreview OpenDev Migration Patch 5 mesi fa
.mailmap Add .mailmap 5 anni fa
.stestr.conf Switch to stestr 1 anno fa
.zuul.yaml Add Python 3 Train unit tests 2 mesi fa
CONTRIBUTING.rst Note to add 'jinja2' and 'markupsafe' to requirements 3 anni fa
HACKING.rst Fix URLs 2 anni fa
LICENSE Add LICENSE and README.rst 5 anni fa
README.rst Replace git.openstack.org URLs with opendev.org URLs 5 mesi fa
RELEASE_NOTES.rst Fix URLs 2 anni fa
bindep.txt add lower-constraints job 1 anno fa
lower-constraints.txt Update docs building 1 mese fa
requirements.txt Update docs building 1 mese fa
setup.cfg Remove openstack-jsoncheck and openstack-indexpage 1 mese fa
setup.py Updated from global requirements 2 anni fa
test-requirements.txt Update docs building 1 mese fa
tox.ini Update docs building 1 mese fa

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