Tools used by OpenStack Documentation

Daniel Bengtsson 9d81e2f9c7 Move flake8 as a pre-commit local target. The goal here is to avoid conflicts between flake8 and hacking version each 2 days. Inspired from nova's approach[1]. The flake8 version to install will be determined by hacking and requirements[2] will stay aligned instead of relying on different versions. [1] https://opendev.org/openstack/nova/src/branch/master/.pre-commit-config.yaml#L26-L35 [2] https://opendev.org/openstack/hacking/src/branch/master/requirements.txt#L1 Change-Id: I131b244cb842dc5f06efc261aafd078e29a058b5		4 months ago
bin	Cleanup doc-tools-check-languages	2 years ago
doc/source	Adding pre-commit	10 months ago
os_doc_tools	Remove openstack-jsoncheck and openstack-indexpage	2 years ago
releasenotes	Switch to newer openstackdocstheme and reno versions	1 year ago
sitemap	Adding pre-commit	10 months ago
test	Merge "Use unittest.mock instead of mock"	11 months ago
.gitignore	Switch to stestr	3 years ago
.gitreview	OpenDev Migration Patch	2 years ago
.mailmap	Add .mailmap	8 years ago
.pre-commit-config.yaml	Move flake8 as a pre-commit local target.	4 months ago
.stestr.conf	Switch to stestr	3 years ago
.zuul.yaml	Dropping lower constraints testing	7 months ago
CONTRIBUTING.rst	setup.cfg: Cleanup and update some urls to latest	2 years ago
HACKING.rst	setup.cfg: Cleanup and update some urls to latest	2 years ago
LICENSE	Add LICENSE and README.rst	8 years ago
README.rst	Replace git.openstack.org URLs with opendev.org URLs	2 years ago
RELEASE_NOTES.rst	Fix URLs	4 years ago
bindep.txt	add lower-constraints job	3 years ago
lower-constraints.txt	Merge "Use unittest.mock instead of mock"	11 months ago
requirements.txt	[goal] Migrate testing to ubuntu focal	12 months ago
setup.cfg	Cleanup py27 support	1 year ago
setup.py	Cleanup py27 support	1 year ago
test-requirements.txt	Adding pre-commit	10 months ago
tox.ini	Merge "Use py3 as the default runtime for tox"	6 months ago

README.rst

Team and repository tags

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