Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* parallelizing building of documents
Update Sphinx version as well.
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. A
couple of variables are also not needed anymore, remove them.
Set openstackdocs_pdf_link to link to PDF file.
Set openstackdocs_auto_name to use project as name.
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: I3544c1f95dd3ce510c00bfeda4f3ced87a3cd60c
Cleanup doc/requirements to just use what is needed for doc building.
Move reno to doc/requirements, add doc8 to test-requirements.
update tox.ini:
* doc8 should be in pep8 as linter and not docs according to PTI [1]
* Only build main doc in docs environment, CI uses this and we waste
just time building api-ref as well, there's a separate environment for
this. This follows PTI [1]
* Do not include requirements file for docs building, it's not needed
with apidoc.
* Use common deps for all docs build environments.
Cleanup doc/source/conf.py, with the switch to api-doc a lot of settings
are not needed anymore, also the eventlet bug is fixed.
Update openstackdocstheme to 1.20.0 and which allows to remove obsolete
setting of html_last_updated_fmt, project, latex_elements from conf.py.
Add doc8 to lower-constraints to make requirments-check happy.
[1] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
Change-Id: If86dd619402495d9d4470b14cb270fcf53db6794
From openstackdocstheme 1.18.0, valid Git URLs can be retrieved by
openstackdocstheme[1], we do not need giturl option anymore.
[1] https://review.openstack.org/532163
Change-Id: Iaff058758c26fec5ae55d711b4390f37f72e79c4
In the project, some of the terminology, like URL, URLs, API, APIs, OpenStack,
UUID, Cinder are neglectfully written as url, api, openstack, uuid, cinder.
This patch is to keep consistent of naming convention.
Change-Id: I98777fb4748cbc58b6e2fd1aca058d3e44069d07
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpeted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Change-Id: I24f83aa15cd4301aac9a7a941fe7d4c1e497c46e
Closes-Bug: #1659390
Signed-off-by: ashish.billore <ashish.billore@gmail.com>
Currently, Cinder api-ref is configured with logABug feature.
When users click "Report bug" button,
it leads to "bugs.launchpad.net/openstack-manuals" which is default.
We should change it to "bugs.launchpad.net/cinder/".
Change-Id: Iabd97f92a9cdc64513fc572630ef223762794f95
Remove useage of old os-api-ref version and replace with current version.
Follow other repositories and merge v1 and v2 in a single document.
Note that we need to have a single document so that preview of the
document works properly in our CI.
Change-Id: I82c8b9ca317298b3dc1f7133ce8c0e9b3503730d
