Commit Graph

4 Commits

Author SHA1 Message Date
Andreas Jaeger 69f4b79813 Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

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.

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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I10e31a8883739e8844b9d974cf4da62cfc28efe0
2020-05-30 16:44:50 +02:00
Andreas Jaeger 2bf5e4c0b3 Cleanup docs building
* Switch to newer openstackdocstheme version and remove values that are
  set now by openstackdocstheme.
* Remove py2 requirments for docs, we only build with python3.
* Update deps for docs building, we don't need the default.
* Remove modindex, this is not build, see
  https://docs.openstack.org/ec2-api/latest/py-modindex.html

Change-Id: I6958cbed944de0a1eea02de10c5a4916b6a7293d
2020-02-23 14:18:20 +01:00
Vu Cong Tuan 5f1377bb94 Fix html_last_updated_fmt for Python3
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: I39e3cc70f51f9ebb2973ea5a7e6cb12d3b19d6cb
Closes-Bug:#1693670
2017-06-04 12:27:00 +07:00
tikitavi 4bbd243f47 add API reference documentation
add documentation for further publishing to OpenStack API Documentation

Change-Id: I5052c101db4763f77f186ee39bc4167409b72aa1
2016-12-15 15:00:47 +03:00