Setuptools v54.1.0 introduces a warning that the use of dash-separated options in 'setup.cfg' will not be supported in a future version [1].
Get ahead of the issue by replacing the dashes with underscores. Without this, we see 'UserWarning' messages like the following on new enough versions of setuptools:
UserWarning: Usage of dash-separated 'description-file' will not be
supported in future versions. Please use the underscore name
'description_file' instead
[1] https://github.com/pypa/setuptools/commit/a2e9ae4cb
Change-Id: I5a3d250b8882389a0fbca6a181a16d9ff46c2949
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove obsolete sections from setup.cfg
- Update requirements, no need for python_version anymore
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine
Change-Id: I785318b3090d7117d74d165ba3236dc239cf9ea1
"warnerrors" was broken in a previous version of [pbr] and most
projects have abandoned it for [sphinx] warning-is-error, which
provides the same functionality.[0] This change removes
"warnerrors" setting and adds the "warning-is-error" setting under
sphinx for enforcing strict documentation building.
Also added pbr>=3.0.0 as a test-requirement
since it contains a fix for invalid characters within commit
messages that can cause docs builds to fail when "warning-is-error"
is enabled.[1]
[0] http://lists.openstack.org/pipermail/openstack-dev/2017-March/113085.html
[1] http://lists.openstack.org/pipermail/openstack-dev/2017-April/115746.html
Change-Id: Ib80e3cca1826ef103d0cd8ec5a7f4cee84f04012
This commit introduces initial infrastructure for building documentation
using the OpenStack's sphinx extension and tox. To demonstrate that
README.md is rewritten into README.rst and should appear in
documentation built by `tox -e docs`.
Partial-Implements: blueprint docs-to-rst
Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
jinyuanliu