12 Commits

Author SHA1 Message Date
Andreas Jaeger
9e457deba0 Fix pygments_style
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.

Change-Id: Icd9d529dbe66626ac53a9fdca5bc6821998a0b7d
2020-05-20 21:56:41 +02:00
Andreas Jaeger
6c963e7712 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.1.2 and reno 3.1.0 versions. Using
these versions will allow parallelizing building of documents.

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.

Set openstackdocs_auto_version to not version the documents.
Set openstackdocs_auto_name to use project as name.

Depends-On: https://review.opendev.org/728432
Change-Id: I4e3ae3ceabe125ea459ed4baabf2e98686268e50
2020-05-15 18:14:20 +02:00
Matt Riedemann
ee41dc9ff9 api-guide: flesh out flavor extra specs and image properties
This adds high level details and links to more detailed docs
in both nova and glance.

This also un-hides the document so it shows up in the table of
contents on the main page. Previously it was being linked from
the general info page and some typos in there are fixed as well.

Change-Id: I495b9ae7855d36cb2597272bcae7ec00360bbed4
2019-11-25 09:19:24 -05:00
Balazs Gibizer
47287f6f94 Documentation for bandwidth support
blueprint: bandwidth-resource-provider
Depends-On: https://review.openstack.org/#/c/640390
Depends-On: https://review.openstack.org/#/c/621494

Change-Id: I166787e092e16857d20f89fba965be2a5509fb4b
2019-03-18 11:24:56 +01:00
Takashi NATSUME
ddf7c6e370 Improve formats of the Compute API guide
Replace the 'NOTE' and 'TODO' words with
the note and todo directives in the Compute API guide.

Improve some format in the guide.
e.g. Fix unnecessary bold characters.

Change-Id: I7e9d6b8a5228886fd5de03d12482481d2b652666
Closes-Bug: #1558459
2018-11-07 04:01:40 +00:00
Stephen Finucane
dd1a416bc9 doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: Ifb99e727110c4904a85bc4a13366c2cae300b8df
2018-05-03 14:34:47 +01:00
chenxing
fbba1d17a4 Fix the bug report link of API Guide
Currently, it redirects back to the same page.

Change-Id: Ia855ad2cfa1fdc42bffac07812799b032a0cc7ce
Partial-Bug: #1737854
2017-12-14 20:38:16 +08:00
Cao Xuan Hoang
d99fd590b0 Removes unnecessary utf-8 encoding
trivialfix

Change-Id: I1294ecb5e85c9bf70a23992e92eeccfd35362551
2016-12-20 10:27:01 +07:00
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
2016-05-23 15:30:20 +03:00
Harshada Mangesh Kakad
c40464514d Replace deprecated library function os.popen() with subprocess
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.

Change-Id: Iea9c0501f46c57d809217912fb0f40eb2bc4f111
Closes-Bug: #1529836
2016-01-06 09:45:21 -08:00
Andreas Jaeger
a54834df23 Report compute-api bugs against nova
For compute-api set the launchpad project users report bugs
against to "nova". Users can report bugs using the "bug icon" that will
directly link to the launchpad project, it currently goes to
"openstack-manuals" which is wrong for this content.

This variable is used by openstackdocstheme 1.2.6.

Closes-Bug: #1524476
Change-Id: I08ba11bb1c5388bc4611cea581274ac5d724c8d9
2015-12-11 06:58:33 +01:00
Anne Gentle
17961c41a3 Rearranges to create new Compute API Guide
Uses openstackdocstheme to match other content

Has a dependent change in project-config also so that
file will build to developer.openstack.org/compute
at https://review.openstack.org/#/c/231000/

Change-Id: Ic060a1e79e4b2f8695cb788ff4df018e0cfd3286
2015-11-12 10:47:23 +00:00