Change-Id: Iadc87779bf513c9d04847b6cf8ecbc60b300d7db Implements: blueprint remove-unicode
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Set openstackdocs_auto_name to use 'project' as name. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Ib5706db978edfdddb88230ee81a563c7976f238a
Change-Id: I5a35911b5658fdf6bc08844b31cc1325b749526a
Make a few cleanups: - Remove python 2.7 stanza from setup.py - Add requires on python >= 3.6 to setup.cfg so that pypi and pip know about the requirement - Remove section from setup.cfg: Wheel is not needed for python 3 only repo - Remove html_last_updated_fmt from source/conf.py, this is not needed anymore. Change-Id: If9708106263493396693771e9bd5265e26de460c
- Follow new PTI for docs build - Add sphinxcontrib.apidoc to replace pbr autodoc REF: https://governance.openstack.org/tc/reference/project-testing-interface.html http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: I078e2ed32da04303203d6c2a3e498f82b9a15939
We were using the old theme on trove docs. We should update to new theme, it includes the new logo as well! You can see the difference in the themes here, new, https://docs.openstack.org/admin-guide/ old, https://docs.openstack.org/developer/python-troveclient/ Change-Id: If5ff925d258f7b4008aff32b1677d7806395b5c9
As part of phase 1, the cli reference should be moved to the local repositories. "This content will move the project-specific client documentation trees under doc/source/cli."[1] I deleted the old reference and auto-generated the cli using the tool here[2] [1]http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html#what-is-happening-to-each-guide [2]https://docs.openstack.org/contributor-guide/doc-tools/cli-reference.html Change-Id: Ie1d5f2629021d738b8247c5335bce433ba5c4a05
Also replaces inline reference guide generation with pbr's feature for doing the same thing. Refer to https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html for details. Change-Id: I0fac75bfe66a1ea30973c2128c054aa2e43c8f8b Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Projectname according to the relevant provisions of the new document style should use lowercase, Service should be used service name instead of project name[1]. [1]:http://docs.openstack.org/contributor-guide/writing-style/openstack-components.html Change-Id: I385aa21b141528f7766f54cd7f067fb67eb8478e Depends-On: I386efb2d5c147417af7ea25704405977c9b6bbcd Depends-On: I5c1714b7839b2736c50f2daa2f4506c4006815a1
The example usage was really out of date and doesn't work on modern clients. This updates it to a functional state. Change-Id: I96bf56e3cd3943f8c0e210dd873bc4cae02a1ea8