openstack
/
openstack-doc-tools
Code Issues Proposed changes
Tools used by OpenStack Documentation
1,292 Commits 1 Branch 50 Tags 6.9 MiB
Python 77.5%
Shell 20.3%
XSLT 2.2%
Go to file
Sean McGinnis 074a84df78 Remove setup.py check from pep8 job 
Using "python setup.py check -r -s" method of checking the package has
been deprecated with the new recommendation to build the sdist and
wheel, then running "twine check" against the output.

Luckily, there is already a job that covers this that only runs when the
README, setup.py, or setup.cfg files change, making running this in the
pep8 job redundant. This covered by the test-release-openstack-python3
that is defined in the publish-to-pypi-python3 template.

More details can be found in this mailing list post:

http://lists.openstack.org/pipermail/openstack-dev/2018-October/136136.html

Change-Id: I359d557dbf3438d219bed0303b7a95ad93192f46
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
 		2018-10-30 10:37:24 -05:00
bin [lang] Fixes PUBLISH_DIR for api-quick-start 2018-04-19 10:47:17 +09:00
doc/source Remove 'autogenerate_config_docs' 2017-10-04 11:47:56 +01:00
os_doc_tools Remove the 'openstack-auto-commands' tool 2017-10-04 11:47:58 +01:00
releasenotes Remove setting of version/release from releasenotes 2017-11-16 21:24:31 +01:00
sitemap Update sitemap file 2018-09-09 12:00:39 +02:00
test Change priorities for sitemap 2017-07-28 20:30:06 +02:00
.gitignore Switch to stestr 2018-07-11 13:10:05 +07:00
.gitreview Add .gitreview 2013-12-04 20:44:41 +01:00
.mailmap Add .mailmap 2014-01-07 08:39:30 +01:00
.stestr.conf Switch to stestr 2018-07-11 13:10:05 +07:00
.zuul.yaml Use openstack-lower-constraints-jobs template 2018-08-30 16:36:07 +02:00
CONTRIBUTING.rst Note to add 'jinja2' and 'markupsafe' to requirements 2016-03-03 17:54:17 +03:00
HACKING.rst Fix URLs 2017-09-07 19:55:58 +02:00
LICENSE Add LICENSE and README.rst 2013-12-10 15:45:37 +01:00
README.rst Update links in README 2018-03-03 13:04:13 +08:00
RELEASE_NOTES.rst Fix URLs 2017-09-07 19:55:58 +02:00
bindep.txt add lower-constraints job 2018-03-25 09:16:50 -04:00
lower-constraints.txt Switch to stestr 2018-07-11 13:10:05 +07:00
requirements.txt Switch to stestr 2018-07-11 13:10:05 +07:00
setup.cfg Remove "cleanup" tools 2017-10-04 11:48:00 +01:00
setup.py Updated from global requirements 2017-03-02 11:52:39 +00:00
test-requirements.txt Switch to stestr 2018-07-11 13:10:05 +07:00
tox.ini Remove setup.py check from pep8 job 2018-10-30 10:37:24 -05:00

README.rst

Team and repository tags

image

OpenStack Doc Tools

This repository contains tools used by the OpenStack Documentation project.

For more details, see the OpenStack Documentation Contributor Guide.

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