openstack/devstack
Code Issues Proposed changes
5e2d0e0bb5
devstack/setup.cfg

25 lines
505 B
INI
Raw Normal View History

Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
[metadata]
name = DevStack
summary = OpenStack DevStack
description-file =
convert README to rst Everything else in our documentation is RST, we should convert the Readme to RST as well (as github supports this, so it's fine to read it there) Change-Id: If2aabf629affc09b5daa570f4ca3bdf268cb53b0
2017-05-02 08:40:26 -04:00
README.rst
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
author = OpenStack
Change openstack-dev to openstack-discuss Mailinglists have been updated. Openstack-discuss replaces openstack-dev. Change-Id: Id639a45680b149ca1ffe8e91fcdea713576b355d
2018-12-04 13:03:28 +00:00
author-email = openstack-discuss@lists.openstack.org
Update URLs Some URLs are broken, so fix them. The others are redirect to new URLs, so replace them with new ones. The config options of nova serial console proxy have been gathered in nova/conf/serial_console.py. So the description in doc/source/guides/nova.rst is fixed. Change-Id: Ifd81cc09969341fbf8f135a913fc6003b94e0acc
2017-07-22 08:59:43 +09:00
home-page = https://docs.openstack.org/devstack/latest
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
classifier =
Intended Audience :: Developers
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
update sphinx Update sphinx to the version used to build the documentation elsewhere and turn on the option to treat warnings as errors to ensure that no poorly constructed rst is introduced. Cap sphinx<1.6.1, since that version has a conflict with pbr right now. Change-Id: I19b3332229e2094988cbf8968c42a0323194a209 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-05-09 07:35:45 -04:00
warning-is-error = 1
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
[pbr]
warnerrors = True
[wheel]
universal = 1
Copy Permalink