summaryrefslogtreecommitdiff
path: root/README.rst
blob: 66c28c0ec58f21fcde387646a395cd9ab93a1e0c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
========================
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