6 Commits

Author SHA1 Message Date
Abraham Arce
a526093ba8 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes
- API Reference

Change-Id: I5a53eecaf97e835e85ea4d5a7fae2bc3ca3d45a8
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:37:08 +00:00
Dean Troyer
5558276784 Add api-ref and relnotes publish jobs
* Add pointers in the main doc to api-ref and releasenotes pages
* Add publish-stx-api-ref and publish-stx-releasenotes jobs
* Add search at bottom of api-ref and relnotes pages to trigger the jobs

Change-Id: Ib41f10ce72eb283d4edbeb1ecc0543403295d7bf
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-11 08:21:53 -05:00
Zuul
2ebe8c2e8e Merge "[Doc] SPDX License Identifier" 2018-10-09 15:17:34 +00:00
Scott Rifenbark
90252d2421 stx-metal: API ref doc content added.
I added the api-ref-sysinv-v1-metal.rst file, which is content
for the API reference manual to the api-ref/source dir. This
represents the converted old-style files to the newer OpenStack
supported RST files.

I updated the index.rst file to include the new .rst file so that
the api-ref document can build.

Updated the actual output using Platform http://10.10.10.2:6385/v1
and querying.

Change-Id: I943dd136b2b083743e053db5070d4da7fbe78685
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-09-28 17:33:34 +00:00
Abraham Arce
d948fdc228 [Doc] SPDX License Identifier
- Change to SPDX-License-Identifier: Apache-2.0

Change-Id: Ie98277f4b8fca7084ff8d3f9622ced048a5d5f9c
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 09:39:07 -05:00
Abraham Arce
0162fa2526 [Doc] OpenStack API Reference Guide
Baseline changes to comply with OpenStack API documentation
from OpenStack Documentation Contributor Guide [0]:

- [1] How to document your OpenStack API service

[0] https://docs.openstack.org/doc-contrib-guide
[1] https://docs.openstack.org/doc-contrib-guide/api-guides.html

Story: 2002712
Task: 24451

Change-Id: I91f7640583081c83d3d43786e979ccfb5bee0490
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-05 19:59:26 -05:00