openstack-doc-tools/README.rst
melissaml 15fe203715 Update links in README
Change the outdated links to the latest links in README

Change-Id: I1f840669bade015e53657cd9f7f553892c0591cc
2018-03-03 13:04:13 +08:00

62 lines
1.5 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/openstack-doc-tools.svg
:target: https://governance.openstack.org/tc/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
<https://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