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_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Disable openstackdocs_auto_name to use 'project' variable 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.
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: I87889f73207ecd940963fbe601ccbb79863b96ac
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: I25030e46ced9b1c77fad543aa9285c053a388f14
A Starlingx patch[1] changed the signature for some openstackdocstheme
methods which is causing Octavia docs to not build.
This patch updates the octavia docs configuration for the new
openstackdocstheme.
[1] https://review.openstack.org/#/c/607298
Change-Id: Id09ab3b78291c28e116f1f4ffb8836eac0537d94
This patch updates the docs configuration to have bugs links that take the
reporter to storyboad instead of launchpad.
It also sets the docs up for PDF rendering and multiple versions of the
documentation.
Change-Id: I66187e09e038efe605db45a26e3505218a7a4c65
Use the new options from openstackdocstheme 1.11, update requirements
for it (syncing with global requirements file).
For details, see https://docs.openstack.org/openstackdocstheme/latest/
Change-Id: I398d0c3fdc07ed184e83c8f25ef7176eac830e30
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: I6cde9bb1f815bae91378772626142dd7645188d7
This patch will create the initial directory and index for the api reference
documentation (using the new guidelines) for the Octavia API.
Change-Id: Id5fbe569acfe7348f4f9dfc9cbef49834ea824c3
Partial-Bug: #1558385
