21 Commits

Author SHA1 Message Date
Andreas Jaeger
b1bad0d43a Simplify conf.py for openstackdocstheme 1.11.0
With the new openstackdocstheme used, we can simplify conf.py.

Also, update our docs for it.

Note that Sphinx 1.6 needs latexmk for building, add it.

Sphinx 1.6 introduces a few new warnings, fix them so that the guides
built.

Change-Id: If2e431725eb54f8be79b9fa4bf9ede2089f321a5
2017-06-27 07:04:30 +02:00
Anne Gentle
c5a4014cb0 Adds section about versions and releases for API reference info
* Describe all the examples of versions related to an OpenStack service
  that provides an API.

Change-Id: I34a53cc2345e98dbe2e1dae819491711e73db6f5
2017-02-16 03:09:26 +00:00
KATO Tomoyuki
380069d9da Use https instead of http for git.openstack.org
Change-Id: I0b76dd67854bd354435a56294c67667eeee1bebd
2017-01-31 13:40:14 +09:00
KATO Tomoyuki
108c17a774 Use https instead of http for openstack sites
Change-Id: I85b773045b30b93183ef0daa3bb5afb26d193a08
2017-01-31 07:36:48 +09:00
KATO Tomoyuki
89b722d36a Use https instead of http for developer.o.o
Change-Id: Iec2c2cebb5e5b7e0cdb760d8d3aafffc6f03602a
2017-01-28 11:51:08 +09:00
Anne Gentle
33891a7f98 Updates Contributor Guide for API docs now that WADL migration is complete
Change-Id: Ibc05df66a8aabdb51fa7b98210a55eab027ebeee
2016-10-11 11:16:50 -05:00
caoyuan
c791578c39 Update the version of "os-api-ref"
Refer to http://git.openstack.org/cgit/openstack/requirements/tree/global-requirements.txt
The version of "os-api-ref" should be ">=1.1.0",this patch fix it.

Change-Id: I7ac3c22a432e3165f4c575fd7bc86b83dc7e754d
2016-09-29 20:15:26 +08:00
Lujin Luo
080459d3fc Revises indentation
In contributor guide, api-guides section, the indentation of
step 4 is incorrect. This patch is supposed to fix it.

Change-Id: I28b33d1fbc00f9b0e370753d2fb894378348ee95
2016-09-28 07:32:23 +00:00
chen-xing
ddfb253d64 [contributor] Reword text in API contributor docs
-start new paragraph for readability
-fix the typo( what->want)

Change-Id: Iaf696ea0c2f28c6a2a689bd11fc47b5c3cbc59cc
Closes-Bug: #1584397
2016-09-05 01:48:37 +00:00
qiaomin
4e2933e744 [contributor-guide] Use "project" to replace "tenant" term in use-guide
This patch use "project" to replace "tenant" term in contributor-guide
for cleanup.

Partial-Bug: #1475005
Change-Id: Idc427db688aca7a5aba8390b796286667b1c09ef
2016-08-18 01:15:47 +00:00
Anne Gentle
b719e363cc Adds info about service naming and api-ref directory/URL
Change-Id: I6e33a50f279d63ede2c19f7aa2c608c8c4296a6f
2016-08-16 12:42:17 +00:00
Anne Gentle
f6c3fe1589 Updates the contributor guide API guides section with latest
- Now that os-api-ref is available as a release, projects should
add it to the test-requirements.txt file for builds.

Change-Id: I600f1dd674fa979b04779b5a6d8ab7e069610dc1
2016-05-20 18:08:29 -05:00
Anne Gentle
6ba21f6276 Adds missing step to add to project's tox.ini file for API Reference
This addition explains how to do local builds.

Change-Id: I890e69331527c9722984aa57956cabfca5527982
2016-05-06 15:30:43 -05:00
Anne Gentle
7e261d61c2 Updated instructions for API migration files
Provides pointer to the api-site patch, plus adds a section for
the overall build and publish process. Should work for both
migrated services as well as new services.

Change-Id: I1ff691d9439096a7f38e94f5c01e61a105f48b80
2016-05-02 12:48:29 -05:00
Jenkins
c779853f5c Merge "Adds more detailed information for optional API reference task" 2016-04-27 23:29:41 +00:00
Anne Gentle
fca045819e Adds more detailed information for optional API reference task
Provides information for how to scrape the current
developer.openstack.org/api-ref.html

Change-Id: I4c9063de10fa2a29b9ee2669b2f04125eafe2091
2016-04-27 14:08:43 -05:00
Anne Gentle
586575f8a9 Updates to the API contributor guide section after Summit walkthrough
Change-Id: I7d75b503afb793c8c052579d89df36d160429a0b
2016-04-27 13:57:15 -05:00
xuchao
0a18b83287 Fix openstack/api-site git repo url
Change-Id: I225d9568f60be7a2c5d379e21948f54367039923
Closes-Bug: #1575714
2016-04-27 13:57:11 -05:00
Andreas Jaeger
e59f040f7d [contributor] Use code-block for api-guide doc
Use code-block and the usual "$" for all commands. This fixes some
inconsistent display.

Change-Id: I57c7f60717246fbceaa6ea45fb1141b7ad59ab05
2016-04-27 07:10:39 -05:00
Anne Gentle
86b61193b1 Updates for how the migration tool works for API reference
Change-Id: I677608b513bd54554f390e65c889948161b40b3e
2016-04-15 21:03:55 -05:00
Anne Gentle
278aed1679 Adds an API guides section to the Contributor Guide
Change-Id: Id876d3a3a02f83b11dcb64ed8a26de934f3733ea
2016-04-12 17:07:06 -05:00