12 Commits

Author SHA1 Message Date
likui
5d641033d4 remove unicode from code
Implements: blueprint remove-unicode
Change-Id: Ib7eb517f404fe87b880f7091366721d2cfc5cdf8
2021-01-03 16:42:47 +08:00
melissaml
b77f7b9fe7 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.

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: Ic5ff4981e5ed09885fd2aaad7508d58d2b2cccc7
2020-06-05 07:39:41 +00:00
Andreas Jaeger
cc1ccae629 Cleanup docs building
Remove build_sphinx from setup.cfg, it's not used anymore since this
repo uses sphinx-build directly.

Require newer openstackdocstheme version and remove settings in conf.py
that are now default.

Remove doc/source/install/conf.py, it is not used anymore.

Change-Id: Id89c664384c3ad443d701f5d4135a9f3f9f744d7
2020-02-22 19:11:19 +01:00
Lingxian Kong
c37ab5f34b docs: fix build failure on html_last_updated_fmt
Error message in CI job build-openstack-api-ref:
The config value `html_last_updated_fmt' has type `bytes'; expected
`str'.

Change-Id: Ie760abeb4a3ea8666da25480a8461812a67514eb
2019-05-28 09:42:08 +12:00
ZhongShengping
6a5afea40a Move to opendev
1.Use opendev.org instead of git.openstack.org.
2.Use review.opendev.org instead of review.openstack.org.

Change-Id: I8e9da8fbb04bdec42a0b2f012f6a38b8ee413b27
2019-04-24 16:08:08 +08:00
Jenkins
f2607bdfc2 Merge "[api-ref] configure LogABug feature" 2016-11-15 23:57:02 +00:00
Jenkins
25d668450b Merge "Config logABug feature for Trove api-ref" 2016-10-04 16:25:00 +00:00
KATO Tomoyuki
c1d2f3de52 [api-ref] configure LogABug feature
To report a bug into the trove project, not default openstack-manuals.

Change-Id: I8e1c16ab070541b00b92dc019ed86bbf71e56bb7
2016-09-27 23:44:17 +09:00
Ha Van Tu
b0170c04d2 [api-ref] Remove temporary block
The os-api-ref 1.0.0 is out. We can remove the support to older
version now.
Reference: https://github.com/openstack/senlin/commit/
6d41feb58dd836d426c9b6f025846dbbf7295097
https://review.openstack.org/#/c/362170/

Change-Id: I4a3697f7f43fdce0620d4faa16166078fe984c25
2016-09-07 12:20:14 +07:00
Ha Van Tu
07e0330de6 Config logABug feature for Trove api-ref
Currently, Trove api-ref is not configured with logABug feature.
When users click "Report bug" button, it leads to
"bugs.launchpad.net/openstack-manuals" which is default.
We should change it to "bugs.launchpad.net/trove/".

Change-Id: I90b37c3ef6b73daf2e05f253b9778ce548a38a1c
2016-08-31 12:39:05 +07:00
Graham Hayes
cbd0f0f080 Get ready for os-api-ref sphinx theme change
Change-Id: I0325c1c42b2ea0b208547e902ff558b9be325d39
2016-08-19 16:44:03 +01:00
Amrith Kumar
3b0d1ea25d Adds the api-ref migrated RST + YAML files
With this email[0], you must migrate API reference docs into RST. The
conf.py and the tox environment are also cribbed from nova.

Still need to retain the install_command in tox.ini, otherwise the
api-ref job fails.

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

Co-Authored-By: Anne Gentle <agentle@cisco.com>
Co-Authored-By: Amrith Kumar <amrith@tesora.com>

Change-Id: I3315261aa18729fa7a6aa79d4a1d6c24de1e2c6b
2016-08-17 17:46:41 -04:00