Commit Graph

13 Commits

Author SHA1 Message Date
sunxifa 5aa867402f Remove unicode to adapt to Python3
Change-Id: I4d8de05aa8e7d0828957c33bda78038794621e95
2021-01-03 11:27:52 +08:00
Andreas Jaeger 2f59a4b632 Switch to newer openstackdocstheme and reno versions
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
2020-05-23 18:06:59 +02:00
Brian Haley c9a1c39eee Stop testing python 2
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
2019-12-09 18:09:13 -05:00
Michael Johnson 5ea72f9f2c Generate PDF documentation
Change-Id: I71a0820f2322be7f84ab6555b534368d76bb0359
Story: 2006101
Task: 35148
2019-09-13 10:51:05 -07:00
Michael Johnson 28f1e74546 Clean up octavia-lib docs and remove oslo.log
This patch cleans up the octavia-lib documentation and removes an
unused requirement for oslo.log.

Change-Id: I4ddcb51fcfb976e825cd204d5f4f561d60ee0455
2019-08-09 11:50:41 -07:00
Andreas Jaeger 43e957f9fe Update for storyboard
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
2019-08-03 17:31:35 +02:00
Andreas Jaeger 05b8ca95fd Fix docstring and avoid such errors
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>
2019-08-03 17:29:12 +02:00
pengyuesheng e0769bac21 Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: I4573e3465fcdfb90c53480e5eddcf7091318fbfb
2019-07-30 16:58:11 -07:00
pengyuesheng cf60c08ab0 Bump the openstackdocstheme extension to 1.20
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
2019-07-26 14:36:08 +08:00
Zuul 1185be7781 Merge "Replace git.openstack.org URLs with opendev.org URLs" 2019-06-05 22:34:11 +00:00
caoyuan 625f171dcd Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I531e92ead8aad8930f477904d5202035067e9f7c
2019-06-05 21:37:22 +00:00
zhangboye 3fc6659b61 Cap sphinx for py2 to match global requirements
Change-Id: I14432befcffbc5bb99fad83dc58eccd983b41fe4
2019-05-16 16:34:54 +08:00
Michael Johnson 5f833c77d2 Initial cookie-cutter commit for octavia-lib
Setting up the base repository for octavia-lib.

Change-Id: I023fe839b39d9d826425aeca5e0fd39dc9c38275
2018-10-12 14:03:43 -07:00