bf8633f11b
There is support for displaying deprecation information in a somewhat structured manner (proper lists, emphasis on titles, etc.). However, the deprecation information is still included in the help text rather than in this flags section. This makes things more difficult than they need to be. Resolve this by instead including any deprecation information in the flags section. This will transform output from something like this: (String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url to this: (String) Host to locate redis. Deprecated Replaced by [DEFAULT]/transport_url Which should be a little more obvious. It's necessary to fix the template, which added the flags at the same level as the title and description, resulting in varying numbers of bullet points for the list. Change-Id: Ifaee90a814fa3efee8b41eb0411535cff70e7309 |
||
---|---|---|
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
.