Tools used by OpenStack Documentation
Go to file
Stephen Finucane d3c952064a Remove 'autogenerate_config_docs'
This tool has been superseded by the 'oslo_config.sphinxext' Sphinx
extension and can finally be put to rest.

[1] https://docs.openstack.org/oslo.config/latest/reference/sphinxext.html

Change-Id: Idae5ba656c3a0da8a26c6f1e63332365c8012c0b
2017-10-04 11:47:56 +01:00
bin Cleanup doc-tools-check-languages 2017-08-02 20:36:44 +02:00
cleanup Keep py3.X compatibility for urllib 2016-03-14 08:27:45 +05:30
doc/source Remove 'autogenerate_config_docs' 2017-10-04 11:47:56 +01:00
os_doc_tools Update sitemap tests 2017-04-29 10:36:27 +10:00
releasenotes Remove 'autogenerate_config_docs' 2017-10-04 11:47:56 +01:00
sitemap Fix to use "." to source script files 2017-08-29 02:18:04 +08:00
test Change priorities for sitemap 2017-07-28 20:30:06 +02:00
tools Add Constraints support 2016-12-13 23:05:47 +01:00
.gitignore Update sitemap tests 2017-04-29 10:36:27 +10: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 Fix URLs 2017-09-07 19:55:58 +02:00
LICENSE Add LICENSE and README.rst 2013-12-10 15:45:37 +01:00
README.rst Remove 'autogenerate_config_docs' 2017-10-04 11:47:56 +01:00
RELEASE_NOTES.rst Fix URLs 2017-09-07 19:55:58 +02:00
bindep.txt Add openssl libs to bindep 2017-06-18 10:58:56 +02: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 Updated from global requirements 2017-09-16 23:21:07 +00:00
setup.cfg Remove 'autogenerate_config_docs' 2017-10-04 11:47:56 +01:00
setup.py Updated from global requirements 2017-03-02 11:52:39 +00:00
test-requirements.txt Updated from global requirements 2017-09-16 23:21:07 +00:00
tox.ini Remove 'autogenerate_config_docs' 2017-10-04 11:47:56 +01: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