10 Commits

Author SHA1 Message Date
Andreas Jaeger
3d105b623d 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.

Disable openstackdocs_auto_name to use 'project' variable as name.

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: I131850d2a5c6164dfd48c9c95885d4754b5236c6
2020-06-03 08:31:04 +02:00
Andreas Jaeger
96b56519bf Update hacking for Python3
The repo is Python using both Python 2 and 3 now, so update hacking to
version 2.0 which supports Python 2 and 3. Note that latest hacking
release 3.0 only supports version 3.

Fix problems found.

Remove hacking and friends from lower-constraints, they are not needed
for installation.

Change-Id: I9bd913ee1b32ba1566c420973723296766d1812f
2020-04-03 21:21:07 +02:00
Ondřej Nový
a32fb30c16 Use SOURCE_DATE_EPOCH in docs to make build reproducible
Set copyright year and html_last_updated_fmt to SOURCE_DATE_EPOCH if
it's set. See https://reproducible-builds.org/specs/source-date-epoch/

This patch make build reproducible, see https://reproducible-builds.org/

Change-Id: I730a8265ca2c70c639ef77a613908e84eb738b70
2019-08-24 21:04:22 +02:00
Tim Burke
ffe51501c2 api-ref: add link to SLO docs from multipart-manifest=put param
Drive-by: run api-ref tox env under py3.

Change-Id: Iebce47eabcb3b198d4aa7c1b8cfaf8f53300f7f9
2019-03-29 16:07:59 -07:00
zhang.lei
39efb51d07 Remove the deprecated "giturl" option
From openstackdocstheme 1.18.0, valid Git URLs can be retrieved by
openstackdocstheme[1], we do not need giturl option anymore.

[1] https://review.openstack.org/532163

Change-Id: I579cebae6486d250915f936f0c1c61008471c089
2018-01-15 03:20:07 +00:00
gengchc2
702c804887 Use https instead of http for git.openstack.org
Trivialfix

Change-Id: I4862d073adecf1cc5312a64795ad890eeddf774d
2017-02-07 11:28:30 +08:00
Nguyen Phuong An
19426182af [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.
Reference:
6d41feb58d

Change-Id: I0b28cd3f6b5c393d63b9ab2b4dcd3b7b3c20f9b4
2016-10-06 16:50:17 +07:00
Nguyen Phuong An
3f00148c6b Config logABug feature for Swift api-ref
Currently, Swift api-ref is not configured with logABug feature.
When users click "Report bug" button, it leads to "openstack-manuals"
which is default.

Change-Id: I3b6fb410000637ff03d99110d440de88a5adc30c
2016-08-31 14:41:30 +07:00
Graham Hayes
aa893d9077 Get ready for os-api-ref sphinx theme change
Change-Id: Ib4aa4a26814273efafa3453237d18acf8cc966cb
2016-08-19 16:44:07 +01:00
Cloud User
4b13879680 Adds migrated API reference files
This brings in RST plus YAML files, migrated from the source for [0].

The migration explanation is found on the openstack-dev mailing list [1].

Project instruction is in the OpenStack Documentation Contributor Guide [2].

A patch for publishing this source is in [3].

The conf.py and the tox environment are standard across other projects.

[0]http://developer.openstack.org/api-ref-objectstorage-v1.html
[1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html
[2]http://docs.openstack.org/contributor-guide/api-guides.html
[3]https://review.openstack.org/#/c/313015/

Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-06-21 19:14:22 +02:00