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: Iec8ad8f132aa68ef8778b6a94266897956f74bd8
Since it's no longer supported past Train, let's stop
running the tests.
Co-authored-by: Ajay Kumar <ajay.k@india.nec.com>
Change-Id: If81d0a45c423c173aa3c40dd2cfce37462dbf900
This patch cleans up the octavia-lib documentation and removes an
unused requirement for oslo.log.
Change-Id: I4ddcb51fcfb976e825cd204d5f4f561d60ee0455
This repo uses storyboard since some time and not anymore launchpad:
Update the openstackdocstheme options so that the "Report a bug" link
points to storyboard and not to launchpad.
Change-Id: I5f42dac1987e0f90860beb12fc842e77cd627820
Docs in octavia where failing with:
Docstring of octavia.api.drivers.amphora_driver.v1.driver.AmphoraProviderDriver.create_vip_port:
10:Unexpected indentation.
The broken docstring is in octavia_lib/api/drivers/provider_base.py. Fix
that docstring and build apidocs - like octavia does - so that all
docstrings in this repo get tested.
For building apidocs, add the needed configuration to the sphinx files
and require the package.
Change-Id: Iad03f19083d9a5429dcfed3499d1c3e2d56cbb0f
Co-Authored-By: Jeremy Stanley <fungi@yuggoth.org>
Co-Authored-By: Adam Harwell <flux.adam@gmail.com>
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: Ie04d6358b9651dfc98ad4533e68ba3aed5398eb2