https://github.com/openstack/openstack-doc-tools

Tools used by OpenStack Documentation. Mirror of code maintained at opendev.org.
https://github.com/openstack/openstack-doc-tools

Last synced: 2 months ago
JSON representation

Tools used by OpenStack Documentation. Mirror of code maintained at opendev.org.

• Host: GitHub
• URL: https://github.com/openstack/openstack-doc-tools
• Owner: openstack
• License: apache-2.0
• Created: 2013-12-03T23:59:44.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-10-11T22:42:03.000Z (8 months ago)
• Last Synced: 2025-03-29T20:08:33.095Z (3 months ago)
• Language: Python
• Homepage: https://opendev.org/openstack/openstack-doc-tools
• Size: 1.43 MB
• Stars: 71
• Watchers: 14
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
========================

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

`_.

* License: Apache License, Version 2.0

* Source: https://opendev.org/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