openstack/openstack-doc-tools
Code Issues Proposed changes
Tools used by OpenStack Documentation
1,169 Commits 1 Branch 63 Tags 7 MiB
Python 77.5%
Shell 20.3%
XSLT 2.2%
bed10f856b
Go to file
Andreas Jaeger bed10f856b Fix building of translated Install Guides on Mitaka 
This fixes https://review.openstack.org/#/c/427596 - to skip the Debconf
guide if it does not exist.

Change-Id: Ic78068b9ce08f878049a07e1bb7891ccf4aa58ab
2017-02-01 14:39:24 +01:00
autogenerate_config_docs Fix TypeError in autohelp.py 2016-12-21 07:45:15 -05:00
bin Fix building of translated Install Guides on Mitaka 2017-02-01 14:39:24 +01:00
cleanup Keep py3.X compatibility for urllib 2016-03-14 08:27:45 +05:30
doc/source Gen autogenerate_config_docs/README.rst 2016-11-15 13:29:20 +00:00
os_doc_tools Merge "[cli-ref] emphasize the warning" 2017-01-26 20:45:10 +00:00
releasenotes Fix building of translated Install Guides on Mitaka 2017-02-01 14:39:24 +01:00
sitemap Mitaka is an old release now 2016-10-06 14:33:34 +02:00
tools Add Constraints support 2016-12-13 23:05:47 +01:00
.gitignore doc-tools unit tests 2016-08-03 07:05:51 +00: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
doc-test.conf.sample Allow setting of publish directory 2014-02-13 14:07:53 -06:00
HACKING.rst doc-tools unit tests 2016-08-03 07:05:51 +00: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 Merge "Show team and repo badges on README" 2016-12-09 18:20:27 +00:00
RELEASE_NOTES.rst Typo fix: occured => occurred 2017-01-23 13:11:50 +07:00
requirements.txt Updated from global requirements 2016-12-23 03:17:51 +00:00
setup.cfg Add py35 to trove classifier 2017-01-07 16:28:12 +01:00
setup.py Updated from global requirements 2015-09-17 12:15:35 +00:00
test-requirements.txt Updated from global requirements 2016-11-02 15:38:34 +00:00
tox.ini H803 have been deprecated 2016-12-17 19:21:48 +08: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

Regenerating config option tables

See autogenerate_config_docs.