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: I7382e562d05010938377815e3dfa37c84d1d485d
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: I7c1f7a9298e6e75389aca6b485bec7b878ba1a20
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
Change-Id: I12d4df4d87aa5b73ac78d7252b49d7db1ef20035
This patch updates the octavia-dashboard tox environment to use stestr.
Depends-On: https://review.openstack.org/570260
Change-Id: I122cd42fea3972d2e9488a1c4239e061edb8a54b
Upper requirements recently bumped sphinx from 1.6.5 to 1.7.4 which
breaks our docs job. This switches the apidocs build to use
sphinxcontrib.apidoc.
Change-Id: I22bfaf4debdf96d902f2158e541cd5036ec1b1dd
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 multiple versions of the documentation.
Change-Id: I1e22125708193c3d8ef43a6dd830b2d5b7a7ea42
This patch adds release notes for the work done in Queens and updates the
release notes tox environment for the new docs requirements.txt.
Change-Id: Idd6c5738d0a353244a672ff711151eb16f24d174
Updates the installation documentation page to include all of the steps
required and updated the contributor.rst to have the correct bugs link to
storyboard.
Change-Id: Ie2dbb61487c1090e153dde3eccc1e27b2de5323c
oslosphinx is obsolete and maintained up to Pike release.
openstackdocstheme is its replacement, and octavia-dashboard has
already switched to it (doc/source/conf.py:html_theme).
Change-Id: I283c24c16a40b706db3485054b7d41a158a14df3
There have been recent changes to how docs jobs are run under zuul [1].
This patch updates octavia-dashboard to be able to run under the new
zuul docs jobs.
[1] https://review.openstack.org/#/c/508694/
Change-Id: I44f7ce2538de0ce76860a3a2b477751de322ab02
This patch updates the imported code to reflect octavia-dashboard.
More work is required to make this work with the Octavia v2 API.
This will be done in followup patches.
Change-Id: I7363105a53642d0003036cada21c5b0cc25efc1a
sunxifa