Commit Graph

10 Commits

Author SHA1 Message Date
Andreas Jaeger
9296424e44 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.

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: I6635fbab5d4cf60be6bc317061cdac2118cebc25
2020-05-21 13:01:11 +02:00
pengyuesheng
5c1f27f69f 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.

This will show other versions of the doc, too.

Change-Id: I2f8e4fec3aa48b91d6ab636504ecc90553a4b802
2019-07-01 15:30:47 +08:00
leiyashuai
8639d9b69f Move openstackdocstheme to extensions in api-ref
Move openstackdocstheme to extensions. According to the guide below:
https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: Iba6c11d432cdfc397f2cd2165c1fae7e7e0813fc
2018-02-12 17:17:25 +08:00
junboli
ee66db5dc9 Fix html_last_updated_fmt in conf.py
1. remove duplicate html_last_updated_fmt in doc/source/conf.py
   the second one cause the new added one not take effect.
2. update html_last_updated_fmt in api-ref/source/conf.py
   use the recommended '%Y-%m-%d %H:%M' data time format.

Change-Id: Ib37b8a05c88667b34438186c55b6eb3f64b64960
2017-09-09 23:01:08 +08:00
rajat29
1a9768ac58 Fix api-ref doc generation for Python3
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.

Closes-bug: #1685147

Change-Id: I6afe143d4db08562b253d130d536d701b1606824
2017-04-21 10:22:23 +00:00
ji-xuepeng
2eefafe5b4 Removes unnecessary utf-8 coding
TrivialFix

Change-Id: I672c1bae22dd066c80c6ef449e31cde664d0be1a
2017-01-22 21:20:55 +08:00
Nguyen Phuong An
583aea4949 [api-ref] Remove temporary block in conf.py
The os-api-ref 1.0.0 is out. We can remove the support to older version
now.

Change-Id: I9974796c2e2ccab5d2f4f651d082632de040f3c4
Reference: Ia6245d502fde38cd4d63aa4a786b6296b22a37a1
2016-09-21 08:26:31 +00:00
Ha Van Tu
24a160907f Config logABug feature for Manila api-ref
Currently, Manila api-ref is configured with logABug feature.
When users click "Report bug" button, it leads to "openstack-manuals"
which is default. We should change it to "manila".

Change-Id: I15d9ce4cc6f9648f49f6ad66de766aa55cab6cbb
2016-09-08 10:25:03 +07:00
Graham Hayes
8210bf5310 Get ready for os-api-ref sphinx theme change
Change-Id: I1c13e4d92d0629361affb5dcd8ae793b33b33c9b
2016-08-19 16:44:03 +01:00
Daniel Gonzalez
3e86e3deac Migrate API reference into tree
The API Documentation team has requires [1] that
projects maintain their api-reference in-tree and
build it to the developer.openstack.org website.

This version of the API reference uses os-api-ref
and compiles API documentation close to that of
the OpenStack compute service (nova).

Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com>

[0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html

Implements: bp move-manila-api-reference-in-tree
Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-07-25 15:55:00 +00:00