d3bc42483a
- add py3 to tox.ini (gate already tests py3) - move all tests to $GITROOT/test so they can all run through testr - add scrapy to test-requirements.txt to support sitemap tests - move tests from test_items.py to test_sitemap_file.py - fix broken sitemap tests - add newton to list of old releases in sitemap_file.py - ignore flake8 H101 as it returns false positives for Sphinx conf.py - Use openstackdocstheme for docs - Update sitemap README - Restructure repo docs - fix minor style issues Change-Id: I22c018149b2eefde6ca5c38c22ac06886fe9a7a8
68 lines
1.6 KiB
ReStructuredText
68 lines
1.6 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/openstack-doc-tools.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
OpenStack Doc Tools
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
This repository contains tools used by the OpenStack Documentation
|
|
project.
|
|
|
|
For more details, see the `OpenStack Documentation Contributor Guide
|
|
<http://docs.openstack.org/contributor-guide/>`_.
|
|
|
|
* License: Apache License, Version 2.0
|
|
* Source: https://git.openstack.org/cgit/openstack/openstack-doc-tools
|
|
* Bugs: https://bugs.launchpad.net/openstack-doc-tools
|
|
|
|
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 :ref:`autogenerate_config_docs`.
|