1b404be30a
Options discovery is 1) complex and 2) partly broken at the moment. This patch adds the ability to use the oslo.config generator to discover options. This is a quick fix to restore some missing options but is porbably not a definitive solution. Ways to improve things: - get rid of all the discovery code and only use the oslo generator - make use of the YAML output from oslo.config (WIP): . https://review.openstack.org/#/c/451081/ . https://review.openstack.org/#/c/458556/ Change-Id: Iaabb5418b103f20bb13c6843482277579e77b51b Partial-Bug: #1668202 |
||
---|---|---|
autogenerate_config_docs | ||
bin | ||
cleanup | ||
doc/source | ||
os_doc_tools | ||
releasenotes | ||
sitemap | ||
tools | ||
.gitignore | ||
.gitreview | ||
.mailmap | ||
.testr.conf | ||
CONTRIBUTING.rst | ||
HACKING.rst | ||
LICENSE | ||
MANIFEST.in | ||
README.rst | ||
RELEASE_NOTES.rst | ||
doc-test.conf.sample | ||
openstack-common.conf | ||
pylintrc | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
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.
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
- License: Apache License, Version 2.0
- Source: https://git.openstack.org/cgit/openstack/openstack-doc-tools
- Bugs: https://bugs.launchpad.net/openstack-doc-tools
Regenerating config option tables
See autogenerate_config_docs
.