openstack
/
openstack-doc-tools
Code Issues Proposed changes
Tools used by OpenStack Documentation
1,303 Commits 1 Branch 62 Tags 7 MiB
Python 77.5%
Shell 20.3%
XSLT 2.2%
Go to file
Andreas Jaeger a178d4b73c Don't use special api-quick-start location 
To simplify publishing of the guide, we don't use the special directory
anymore, remove it for translated documents as well.

Change-Id: I0520314f4946736b78e9d7438d676739c741f7b1
 		2019-07-23 13:38:28 +02:00
bin Don't use special api-quick-start location 2019-07-23 13:38:28 +02:00
doc/source Advancing the protocal of the website to HTTPS in README.rst. 2018-11-14 01:11:46 +08:00
os_doc_tools Remove the 'openstack-auto-commands' tool 2017-10-04 11:47:58 +01:00
releasenotes Advancing the protocal of the website to HTTPS in README.rst. 2018-11-14 01:11:46 +08:00
sitemap Advancing the protocal of the website to HTTPS in README.rst. 2018-11-14 01:11:46 +08:00
test Change priorities for sitemap 2017-07-28 20:30:06 +02:00
.gitignore Switch to stestr 2018-07-11 13:10:05 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:34:21 +00:00
.mailmap Add .mailmap 2014-01-07 08:39:30 +01:00
.stestr.conf Switch to stestr 2018-07-11 13:10:05 +07:00
.zuul.yaml Add Python 3 Train unit tests 2019-06-24 09:13:29 -04: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 Replace git.openstack.org URLs with opendev.org URLs 2019-04-23 03:16:36 +00:00
RELEASE_NOTES.rst Fix URLs 2017-09-07 19:55:58 +02:00
bindep.txt add lower-constraints job 2018-03-25 09:16:50 -04:00
lower-constraints.txt Update hacking 2018-12-11 08:19:26 +01:00
requirements.txt Switch to stestr 2018-07-11 13:10:05 +07:00
setup.cfg Add Python 3 Train unit tests 2019-06-24 09:13:29 -04:00
setup.py Updated from global requirements 2017-03-02 11:52:39 +00:00
test-requirements.txt Update hacking 2018-12-11 08:19:26 +01:00
tox.ini Add Python 3 Train unit tests 2019-06-24 09:13:29 -04: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