OpenStack library for config
Go to file
Stephen Finucane 78698b5c99 Convert rst to plaintext for oslo.config output
This lets us use powerful rST roles and directives in our help text
without these being emitted to the configuration file, where they don't
read quite as well. It also fixes our formatting somewhat, which is
nice.

Note that we're doing something funky where we disable line wrapping. We
can't totally disable this due to how rst2txt works, so instead we set
the line length to an arbitrarily long line length, which is taken from
RFC5322 (Internet Message Format) for want of something better. I
personally question whether anyone is configuring this, but that's a
fight for another day.

Also note that this might caught issues for people who are using invalid
rST in their docstrings or use roles/directives in their config options
that aren't part of the standard Sphinx set or oslo.config set. They
will already be seeing the former issues if they are using the
'sphinxext' extension though, and the latter sounds like it would be
fairly rare.

Change-Id: I6c7208f0facfb4f334d7440cb6a9562901543dd3
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-07-23 11:47:05 +02:00
.zuul.d Add Python3 victoria unit tests 2020-04-14 10:13:32 +00:00
doc Fix pygments style 2020-06-04 16:00:30 +08:00
oslo_config Convert rst to plaintext for oslo.config output 2020-07-23 11:47:05 +02:00
releasenotes Fix pygments style 2020-06-04 16:00:30 +08:00
.coveragerc Fix coverage configuration and execution 2015-10-05 17:20:49 -04:00
.gitignore mypy: Add boilerplate configuration 2020-02-12 09:56:58 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:35:49 +00:00
.stestr.conf Migrating oslo.config to use stestr 2019-01-15 16:15:34 +08:00
CONTRIBUTING.rst Align contributing doc with oslo's policy 2020-05-04 18:21:14 +02:00
HACKING.rst Update URLs in documents according to document migration 2017-07-12 22:32:03 +08:00
LICENSE Add LICENSE file 2013-02-17 09:25:32 +00:00
README.rst update source link in readme 2019-10-15 10:53:35 +08:00
bindep.txt [ussuri][goal] Drop python 2.7 support and testing 2020-02-03 15:12:02 +00:00
lower-constraints.txt Convert rst to plaintext for oslo.config output 2020-07-23 11:47:05 +02:00
requirements.txt drop use of pkg_resources 2020-07-05 19:37:01 -04:00
setup.cfg Convert rst to plaintext for oslo.config output 2020-07-23 11:47:05 +02:00
setup.py remove outdated header 2020-02-10 18:34:03 +01:00
test-requirements.txt Merge "Raise hacking minimum to 3.0.1" 2020-05-25 13:20:17 +00:00
tox.ini Merge "mypy: Add boilerplate configuration" 2020-03-07 21:39:29 +00:00

README.rst

Team and repository tags

image

Oslo Configuration Library

Latest Version

Downloads

The Oslo configuration API supports parsing command line arguments and .ini style configuration files.