starlingx/docs
Code Issues Proposed changes
ed5bddca67
docs/api-ref/source/index.rst

16 lines
270 B
ReStructuredText
Raw Normal View History

[Doc] OpenStack API Reference Guide Staging Repos Baseline changes to comply with OpenStack API documentation from OpenStack Documentation Contributor Guide [0] for the following StarlingX staging repos: - stx-python-cinderclient - stx-nova - stx-glance - stx-neutron Changes: - [1] How to document your OpenStack API service - Adding SPDX-License-Identifier: Apache-2.0 [0] https://docs.openstack.org/doc-contrib-guide [1] https://docs.openstack.org/doc-contrib-guide/api-guides.html Story: 2002712 Task: 26728 Change-Id: Ie8a142360b7c57d7ec477559757aa8295feb09ff Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 11:45:10 -05:00
======================
stx-docs API Reference
======================
StarlingX Documentation
.. toctree::
:maxdepth: 2
stx-docs: API ref doc content added for remaining 4 docs. I added the api-ref-blockstorage-v2-cgcs-ext.rst, api-ref-compute-v2-cgcs-ext.rst, api-ref-image-v2-cgcs-ext.rst, and api-ref-networking-v2-cgcs-ext.rst files, which are content for the remaining 4 API reference manuals 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. Change-Id: I4c3e89d38b1e6afd52d0307fb95be8c0d974ff45 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-09-25 17:11:58 -07:00
api-ref-blockstorage-v2-cgcs-ext
api-ref-compute-v2-cgcs-ext
api-ref-image-v2-cgcs-ext
api-ref-networking-v2-cgcs-ext
Add api-ref publish job * Add pointers in the main doc to api-ref and releasenotes pages * Add publish-stx-api-ref job * Add search at bottom of api-ref and relnotes pages to trigger the jobs * Add openstackdocstheme installation into requirements file Change-Id: I11db7e584f3e16f1fd0517a5c0059bdc2d448399 Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-11 08:40:19 -05:00
:ref:`search`
Copy Permalink