7 Commits

Author SHA1 Message Date
Dean Troyer
97252e1fc8 Use correct docs jobs
* Use build-openstack-docs-pti for the main docs job rather than
  the old legacy build-openstack-sphinx-docs-python3
* Use build-openstack-api-ref for the api-ref job (we can not
  use OpenStack's api-ref-jobs template as it includes their
  publisih jobs)

Change-Id: I646090e4dcc3260b3d963434a228bd5ef3a919fc
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-09-27 16:18:24 -05:00
Scott Rifenbark
ea38cb456d 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-26 17:30:24 +00:00
Abraham Arce
ccd043a129 [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 17:07:17 -07:00
Dean Troyer
51c2529fe2 Add docs build jobs
Start with building Sphinx, include links to the anticipated locations
for /releasenotes and /specs.

Change-Id: I111e4dfc2a31a97b869df25e0d059b8423d25d6a
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-09-04 09:58:56 -05:00
Dean Troyer
d4fd23d60b Update base with current OpenStack PTI config
* rename docs to doc
* adds conf.py
* adds tox 'docs' environment and sphinx-build call
* remove bashate from linters env
* clean yaml lint error

Change-Id: I9cbacea395b13554162f955ddb57e54365952f95
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-07-23 16:14:10 -05:00
Erich Cordoba
812c86bacd Create initial template for documentation
[dtroyer: fixed linters job and added to gate queue so this can be merged]

Story: 2002813
Task:  22727
Change-Id: I8a988cc49440b21176dc95bd12ad383836148dca
Signed-off-by: Erich Cordoba <erich.cordoba.malibran@intel.com>
2018-07-23 11:10:41 -05:00
OpenStack Project Creator
7960d6a13a Added .gitreview 2018-07-03 05:22:28 +00:00