4e6eec5c9beb0086ab370f5506ab73efe1705631
10 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
|
Vu Cong Tuan
|
0808398487 |
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. Changing Popen to .check_output because of 3 reasons: 1. check_output() will raise CalledProcessError if the called process returns a non-zero return code. 2. For consistency with keystone [1] and cinder [2] 3. It makes the code look much better. [1] https://review.openstack.org/#/c/457142/ [2] https://review.openstack.org/#/c/433081 Change-Id: Ia3e792c512da46c2b92d3ad9ec1657849d379052 |
||
|
Cao Xuan Hoang
|
d99fd590b0 |
Removes unnecessary utf-8 encoding
trivialfix Change-Id: I1294ecb5e85c9bf70a23992e92eeccfd35362551 |
||
|
Ha Van Tu
|
174f5a0a21 |
[api-ref] Update configuration file
This patch updates the configuration file by removing the redundant lines. Change-Id: I2811af505f87a9f47e55410d8d0178414a44fe5f |
||
|
Sean Dague
|
476f126c66 |
Make api-ref bug link point to nova
The openstackdocstheme includes a bug reference link, which defaults to openstack manuals. We want to update this to be a Nova bug instead. This also cleans up the pre openstackdocstheme support code Change-Id: Iace4619c37b04b1504a7051e9e5274b2a3b77c24 |
||
|
Graham Hayes
|
389ded42e0 |
Get ready for os-api-ref sphinx theme change
We need some magic to keep the build working as we move away from oslosphinx and towards openstackdocstheme, the theme we are going to use for all the docs. For more details see: http://lists.openstack.org/pipermail/openstack-dev/2016-August/101996.html Change-Id: I378b1afade4725758c024e06b239b0af64d1b19a |
||
|
Jenkins
|
220439fcd6 | Merge "Make available to build docs with python3" | ||
|
Andrey Volkov
|
9053a4685b |
Make available to build docs with python3
On Ubuntu 16.04 a tox package is for python3 by default and this causes errors in building docs in tox enviroment. In these changes iterators are replaced with lists where it's needed. Also external command calls result are decoded from bytes to unicode. Change-Id: I88ef54405b4bc13c269bdda55ae8289676311ee1 |
||
|
Sean Dague
|
2b7d5dec67 |
migrate to os-api-ref
os-api-ref is released on pypi now, so we can move to using it instead of our in tree version. All future extension fixes will happen over there instead of here. Change-Id: Iee4b9c94b8b66a5b0481dd0b15beda03328c4f31 Depends-On: I0e615d36a2e5a8fa0d83f20bdcc2c33ad868ebd5 |
||
|
Thomas Bechtold
|
82a23c682e |
Fix doc build if git is absent
When building packages if git is absent, then we should not set html_last_updated_fmt. It can still be set via the -D switch when building with sphinx-build. Change-Id: I5da86b7a163c0e795cd34abf79b0980a8552f79b Closes-Bug: #1552251 |
||
|
Sean Dague
|
68ec070645 |
Create api-ref docs site
This creates a stub for landing content to support having the source
for the api-ref site in our source tree. It includes a new sphinx
extension that will be used to generate the html needed for the site
which supports 2 new stanzas:
.. rest_parameters::
This uses a parameters yaml file to look up the definitions of
parameters and produce a structured table of those parameters and how
they are used.
.. rest_method::
This is a stanza used inside a section which specifies the REST method
(i.e. GET /servers/{id}) which is then used to produce a nice
collapsable section.
This uses quite a bit of the sphinx extension API, and tries to
document any non obvious actions.
This extension needs additional styling from bootstrap, and some
custom js / css to do the theming / collapsing. That's included as
part of this.
Change-Id: I41b568b782d3c85f6ef8d3bb3a6f4ae378e4dc33
|