Commit Graph

22 Commits

Author SHA1 Message Date
Andreas Jaeger 3698744ba0 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: I481525b51df5937a9fec6c0a7528dd6ea5b6c31b
2020-05-21 12:47:37 +02:00
pengyuesheng e64e96ce3d 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: I9ffdc1077842968b0b53ced732b6c8c52afba453
2019-07-04 16:11:50 +08:00
zhurong 20af772ee7 Fix pep8 E402
Change-Id: Ie8eda174a6da50a222e4070a18a421eff28b6119
2019-01-09 13:23:29 +08:00
sunqingliang6 dc44b56dd7 fix typos
Change-Id: I01a73325ad1240805f1402352c7244eff3253cc3
2018-06-25 17:15:34 +08:00
Jenkins e73d7a049b Merge "List environments api document" 2017-09-20 02:43:05 +00:00
chenaidong1 5a5f9c89d4 List environments api document
According to code implementation,'List environments' api include
parameters 'all_tenants' and 'tenant'. Parameter 'tenant' is not
described in document.

Change-Id: Ie5ea72903202a6674f2de23de139665d3872d0ed
2017-09-18 06:14:10 +00:00
shangxiaobj 4065ed27f8 [Trivialfix]Fix typos in murano
Fix the typos found in murano.

Change-Id: If9f610dee6330905223ad5cddd011ac4044a40f6
2017-09-18 01:02:18 +00:00
Andreas Jaeger d26e77908a Use openstackdocstheme everywhere
Update to use current 1.11 version of openstackdocstheme for all
documents.

Change-Id: I9e615e48267f61769a73268624e1c6b86c100da6
2017-06-30 11:09:07 +00:00
Jenkins f5c619261e Merge "docs: Add (static) actions API to api-ref." 2017-06-14 03:23:14 +00:00
Felipe Monteiro cd1a5d7a1d docs: Add search package API to api-ref.
This commit adds the search package API to api-ref.

Change-Id: I05cbd8d91427549923f51fd4f31bd84cd30f06d4
Partially-Implements: blueprint murano-api-ref
2017-06-12 02:22:03 +00:00
Felipe Monteiro 14f3893c98 docs: Add (static) actions API to api-ref.
This commit adds the static (actions) API to api-ref.

Change-Id: I7a5e8781f9b2d5cdbecb58c55cf55fb0d2edbb21
Partially-Implements: blueprint murano-api-ref
2017-06-11 03:08:39 +01:00
Felipe Monteiro ed4a6b5ddc Updates environment api-ref.
This patch makes the following changes to the environment api-ref:
  - Adds an environment overview
  - Removes 500 error codes (any endpoint can arguably throw a 500
    but a 500 is not an expected error code)
  - Adds additional status codes that can be returned by endpoints
  - Updates deprecated response bodies

Also adds X-Openstack-Request-Id to response parameters throughout
the murano api docs that are currently missing it.

Change-Id: I77f88a29639bae6612a46e800444e9b34485c2af
2017-05-04 02:53:04 +00:00
Felipe Monteiro 5f8d75b063 Updates package api-ref.
This patch makes the following changes to the package api-ref:
  - Adds an package overview
  - Removes 500 error codes (any endpoint can arguably throw a 500
    but a 500 is not an expected error code)
  - Adds missing X-Openstack-Request-Id from response parameters
    for consistency
  - Adds additional status codes that can be returned by endpoints
  - Updates deprecated response bodies

Change-Id: I2f103c2a67a4831d7ad0c47ce142a3a82accc0ba
2017-04-28 17:59:02 +01:00
Jenkins ef0db13459 Merge "Add environment templates to api-ref" 2017-04-27 00:58:00 +00:00
Felipe Monteiro 4ddff85b44 Add environment templates to api-ref
This patch adds the environment templates api to api-ref.

Change-Id: I42d7016196839ac00ae14663f7addde3746ea1d1
Partially-Implements: blueprint murano-api-ref
2017-04-26 21:35:24 +01:00
Felipe Monteiro 1fa55cca05 Add deployments to api-ref
This patch adds the deployments api to api-ref.

Change-Id: If5042f558cf755a738a67daba8e1fe4d6dad055f
Partially-Implements: blueprint murano-api-ref
2017-04-26 17:16:09 +01:00
Felipe Monteiro 275a4e0820 Add sessions to api-ref
This patch adds the sessions api to api-ref.

Change-Id: I71104f7e5259cb59b8797f128a4929faeb346885
Partially-Implements: blueprint murano-api-ref
Depends-On: I08409cd9dbcb550fa413f99e11a3c38a5ba9e2cf
2017-04-26 14:06:37 +00:00
Felipe Monteiro cb18b647ca Add categories to api-ref
This patch adds the categories api to api-ref.

Change-Id: I08409cd9dbcb550fa413f99e11a3c38a5ba9e2cf
Partially-Implements: blueprint murano-api-ref
2017-04-26 02:19:54 +00:00
M V P Nitesh 580b09d1d4 Fix doc generation for Python3
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpeted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: I6e940404bb7109249257d2adf6aed0a71d7bed72
2017-04-21 08:58:25 +00:00
zhurong 2f27932027 Add packages to api-ref
This patch add the packages api to api-ref

Change-Id: I1693d444f1bc8bd15e1e1d1eda81d018733771e6
Partially-Implements: blueprint murano-api-ref
2017-04-10 08:54:01 +08:00
zhurong 1b0280a07f Add environments to api-ref
This patch add the environments api to api-ref

Change-Id: Idfb2807a5b8e5e58c552a5b69440a005d4bb3183
Partially-Implements: blueprint murano-api-ref
2017-03-23 14:20:05 +08:00
zhurong 12a7f8e455 Initial commit for murano api-ref
This is the first commit for add murano api-ref.

Partially-Implements: blueprint murano-api-ref
Change-Id: I943e01f5ab8721e0452d900e5e24540cbdeb9fa2
2017-01-03 15:30:35 +08:00