Commit Graph

10 Commits

Author SHA1 Message Date
Andreas Jaeger
a7f2e2102d 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: Ic07c726697a8ed7d0a837bf0d16feec222e805f1
2020-05-21 17:13:23 +02:00
Andreas Jaeger
0df6b5be96 Update for Storyboard
This project uses storyboard for new bugs, so fix a few places:

* Fix the "Report a bug" links so that bugs get reported against
  storyboard, not launchpad.
* Update CONTRIBUTING to link to storyboard.

Change-Id: I2760db2e14015407af46ec52ffe4883262ccb5ba
2019-08-02 10:53:32 +02:00
pengyuesheng
749a792eb4 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: I1e6e570d4db575d611212198d11ee4b84884ab23
2019-08-01 09:41:35 +08:00
wanghui
e94f1a22e6 Move openstackdocstheme to extensions in api-ref
Move openstackdocstheme to extensions. According to the guide below:
https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: I58de11278e0cd203312c910057285800f82eb5d7
2018-03-27 10:41:45 +08:00
Vu Cong Tuan
802b0b41c2 Fix html_last_updated_fmt for Python3
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: Iaf2d32dd0da096bdfe66dd651b371f7552ab4fe6
Closes-Bug:#1693670
2017-06-04 12:09:32 +07:00
gengchc2
fecaa22aec Use https instead of http for git.openstack.org
Trivialfix

Change-Id: I3dda5d7d01e548e640aef77aca1402dd268ce0cf
2017-02-07 11:11:22 +08:00
Jenkins
0895f7f92d Merge "[api-ref] configure LogABug feature" 2016-10-13 15:38:53 +00:00
pawnesh.kumar
96b66a227e [api-ref] configure LogABug feature
To report a bug into the magnum project, not default openstack-manuals.

Closes-Bug: #1630524

Depends-on: I51feb6ccdc0fab91a591568866e6801f2bbb319b

Change-Id: I2238ee04b438c4153001da0227d1a848aacd14a8
2016-10-05 14:24:21 +00:00
Andreas Jaeger
bd31e7c566 [api-ref] Remove temporary block in conf.py
os-api-ref 1.0 is released, remove temporary block from
api-ref/source/conf.py.

Change-Id: Ia6fa9ca467d2a24850ce3b9221bdd7f05ed94aa5
2016-10-04 00:52:35 +00:00
Hieu LE
cdd14f209e Init api-ref structure and requirements
This patch init api-ref document structure and
adding some requirements based on the guidance of
OpenStack API team.

Get ready for os-api-ref sphinx theme change

Change-Id: I896c8752fbcf15ec8e5bc6b3862a1ed040936215
Implements: blueprint magnum-doc-rest-api
2016-08-29 22:44:08 +07:00