Commit Graph

14 Commits

Author SHA1 Message Date
liyou01 9ce1a11451 remove unicode from code
Change-Id: Ie452dbdd42ec7ef34993572ac0b456562aabab79
2021-01-07 14:37:16 +08:00
gugug 11abfacbb8 Fix pygments style
New theme of docs respects pygments_style.

more info: http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I4dc7389756a4bfd6da62841456bf1653637b0371
2020-05-21 01:23:45 +00:00
gengchc2 cdd34ec059 Add search option for list query
Change-Id: I3a2f021f5d9e104539fc1550713553f6c86df553
2018-11-29 08:47:09 +00:00
Cai Hui 9aa9028636 Update jobs(v2) api-def
Fix some bugs of jobs(v2) in api-ref
1.The respense of "Show Jobs" is missing a "session_id" paramenter.
2.The files of job-create-request.json, job-update-request.json  have a
 unnecessary items "project_id"
3.The "project_id" is a public paramenter in freezer_action, so changed
its loaction in the files of job-get-response.json,job-list-response.json.

Change-Id: I0e24a5d5eabb1323c53c5268bbeadf4418c11fae
2018-11-05 01:02:50 -05:00
Cai Hui cb835298b1 Update clients(v2) api-ref
Fix some bugs of backups(v2) in api-ref

Change-Id: I3fb692280933035ea95f1d3aba58425fd75e6309
2018-10-30 01:44:49 -04:00
Cai Hui 113089683d Update backups(v2) api-ref
Revising some wrongs of backups(v2) in api-ref docs

Change-Id: Ic04b60bcf32df5f33899fae6610785533edbfa6c
2018-10-29 05:57:14 -04:00
Cai Hui d79df98a34 Update actions-v2 api-ref
Revising some wrong interface parameters of actions-v2

Change-Id: Ie71b51dda2cfbdc0aa3f6228d3881aab3b21eacd
2018-10-26 23:42:37 -04:00
Cai Hui cee24d3acd Update Backup Service api-ref
Add Backup Service API v2 reference.

Change-Id: Ib56c0a87c92c48daa705b75c09e1c5b3b1c3cd5a
2018-10-25 06:53:06 -04:00
zhang.lei b040c33f56 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: I805d613429970d38d73396cbe5cdb462be4f9bfc
2018-01-15 03:47:00 +00:00
howardlee 33d1e5e379 [api-ref]Fix api-ref wrong style
Trivialfix. Fix a wrong style n api-ref.

Change-Id: I690d913c60acf55a15a0eeb3f40bc32002004497
2017-07-20 02:59:37 +00:00
Vu Cong Tuan 9035a32cf9 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 2 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]

[1] https://review.openstack.org/#/c/457142
[2] https://review.openstack.org/#/c/433081

Change-Id: Ie5fc71b2d9e53a0beef86d411da1d680cccf3dd2
2017-06-09 11:21:10 +07:00
Saad Zaher 69719590b7 Updated freezer-api api-ref documentation
* Update api-ref structure
   * Added v2
   * Backup list
   * Job list
   * Job Create

Implements blueprint implement-api-ref-doc

Change-Id: I643ca44565331ef9d0fc36189d60489523e3235e
2017-04-26 15:24:26 +00:00
Andreas Jaeger 15233f9bf3 Docs: Various fixes
Treat warnings as errors when building documents to early spot problems.

Fix api-ref set up:
* Add openstackdocstheme for api-ref building instead of oslosphinx and
  configure it properly.
* Setup api-ref log-a-bug correctly for this project.
* Remove unneeded extra install command

Fix install-guide set up:
* Add tox environment

Fix releasenotes set up:
* Fix conf.py settings to build without errors, remove index, we don't
  need it.

fix docs set up:
* Use Sphinx 1.5 warning-is-error option for normal build_sphinx.
* use oslo sphinx
* Remove wrong static path setting

Change-Id: I07ce9db9fdb526ab4b083c65afa99c38bb508146
2017-03-08 21:02:46 +01:00
Saad Zaher 977ca7c548 Implemented: Installation documentation and API Ref
integrated freezer-api with openstackdoctheme lib and
os-api-ref lib to build the installation documentation
and api reference for freezer.

Change-Id: Ib5fc5f8227484525a13c3cfff9acb13d2b384e1a
Implements: blueprint implement-install-doc
Implements: blueprint implement-api-ref-doc
2016-09-07 13:20:34 +00:00