openstack/openstack-doc-tools
Code Issues Proposed changes
Tools used by OpenStack Documentation
1,322 Commits 1 Branch 63 Tags 7 MiB
Python 77.5%
Shell 20.3%
XSLT 2.2%
7ee77130c4
Go to file
Andreas Jaeger 7ee77130c4 Switch to newer openstackdocstheme and reno versions 
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I5f985549671e3b4f8c438f247fae0818d25b21f5
2020-05-29 12:45:49 +02:00
bin Cleanup doc-tools-check-languages 2019-08-15 20:35:40 +02:00
doc/source Switch to newer openstackdocstheme and reno versions 2020-05-29 12:45:49 +02:00
os_doc_tools Remove openstack-jsoncheck and openstack-indexpage 2019-08-19 13:04:13 +00:00
releasenotes Switch to newer openstackdocstheme and reno versions 2020-05-29 12:45:49 +02:00
sitemap Update sitemap for Python3 2020-03-24 12:04:33 +01:00
test Update hacking for Python3 2020-03-30 12:03:26 +00: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 Drop python 2.7 support and testing 2020-01-27 17:03:20 +01:00
bindep.txt add lower-constraints job 2018-03-25 09:16:50 -04:00
CONTRIBUTING.rst setup.cfg: Cleanup and update some urls to latest 2019-10-22 11:22:44 +08:00
HACKING.rst setup.cfg: Cleanup and update some urls to latest 2019-10-22 11:22:44 +08:00
LICENSE Add LICENSE and README.rst 2013-12-10 15:45:37 +01:00
lower-constraints.txt Switch to newer openstackdocstheme and reno versions 2020-05-29 12:45:49 +02: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
requirements.txt Switch to newer openstackdocstheme and reno versions 2020-05-29 12:45:49 +02:00
setup.cfg Cleanup py27 support 2020-04-05 10:14:14 +02:00
setup.py Cleanup py27 support 2020-04-05 10:14:14 +02:00
test-requirements.txt Switch to newer openstackdocstheme and reno versions 2020-05-29 12:45:49 +02:00
tox.ini Drop python 2.7 support and testing 2020-01-27 17:03:20 +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