oslo.config/setup.cfg
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

56 lines
1.6 KiB
INI

[metadata]
name = oslo.config
summary = Oslo Configuration API
description-file =
README.rst
author = OpenStack
author-email = openstack-discuss@lists.openstack.org
home-page = https://docs.openstack.org/oslo.config/latest/
python-requires = >=3.6
classifier =
Development Status :: 5 - Production/Stable
Environment :: OpenStack
Intended Audience :: Developers
Intended Audience :: Information Technology
License :: OSI Approved :: Apache Software License
Operating System :: OS Independent
Programming Language :: Python
Programming Language :: Python :: 3
Programming Language :: Python :: 3.6
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3 :: Only
Programming Language :: Python :: Implementation :: CPython
[extras]
# package dependencies for optional behavior in the config generator.
# e.g.: oslo.config[generator]
rst-generator =
rst2txt>=1.1.0 # BSD
sphinx>=1.8.0,!=2.1.0 # BSD
[files]
packages =
oslo_config
[entry_points]
console_scripts =
oslo-config-generator = oslo_config.generator:main
oslo-config-validator = oslo_config.validator:main
oslo.config.opts =
oslo.config = oslo_config._list_opts:list_opts
oslo.config.driver =
remote_file = oslo_config.sources._uri:URIConfigurationSourceDriver
[mypy]
show_column_numbers = true
show_error_context = true
ignore_missing_imports = true
follow_imports = skip
incremental = true
check_untyped_defs = true
warn_unused_ignores = true
[mypy-oslo_config.tests.*]
ignore_errors = true