Add project links and pages for API Ref and Release Notes

The project-specific docs are published independently so we need
to maintain the links into those subtrees (/stx-*), also
for the api-ref (/api-ref/stx-*) and releasenotes (/releasenotes/stx-*).

Also add docs env to the default list in tox.ini.

Change-Id: If68e6c984d684af05124b3252a8ff3c4b44b6d82
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
This commit is contained in:
Dean Troyer 2018-10-12 16:11:47 -05:00
parent ed5bddca67
commit e3a11084e2
5 changed files with 82 additions and 13 deletions

View File

@ -2,10 +2,20 @@
stx-docs API Reference
======================
StarlingX Documentation
StarlingX Project API References:
* `Bare Metal <stx-metal/index.html>`__
* `Configuration <stx-config/index.html>`__
* `Distributed Cloud <stx-distcloud/index.html>`__
* `Fault Management <stx-fault/index.html>`__
* `High Availability <stx-ha/index.html>`__
* `NFV <stx-nfv/index.html>`__
* `Software Updates <stx-update/index.html>`__
StarlingX also has API References for the modified OpenStack APIs:
.. toctree::
:maxdepth: 2
:maxdepth: 1
api-ref-blockstorage-v2-cgcs-ext
api-ref-compute-v2-cgcs-ext

View File

@ -0,0 +1,22 @@
======================
stx-docs API Reference
======================
StarlingX Project API References:
* `Bare Metal <stx-metal/index.html>`__
* `Configuration <stx-config/index.html>`__
* `Distributed Cloud <stx-distcloud/index.html>`__
* `Fault Management <stx-fault/index.html>`__
* `High Availability <stx-ha/index.html>`__
* `NFV <stx-nfv/index.html>`__
* `Software Updates <stx-update/index.html>`__
StarlingX also has API References for the modified OpenStack APIs:
* `Block Storage v2 <stx-docs/api-ref-blockstorage-v2-cgcs-ext.html>`__
* `Compute v2 <stx-docs/api-ref-compute-v2-cgcs-ext.html>`__
* `Image v2 <api-ref/api-ref-image-v2-cgcs-ext.html>`__
* `Network v2 <api-ref/api-ref-networking-v2-cgcs-ext.html>`__
:ref:`search`

View File

@ -2,19 +2,38 @@
StarlingX Documentation
=======================
Abstract
========
Welcome to the StarlingX project documentation for [version].
This is the general documentation for the StarlingX project.
View the VERSION Release Notes <https://docs.starlingx.io/releasenotes>
for release specific details.
Projects
========
The following versions of the documentation are available:
StarlingX contains a number of sub-projects that include additional
Edge Cloud support services and clients.
StarlingX v1 | StarlingX v2 | StarlingX v3
* `Bare Metal <stx-metal/index.html>`__
* `Clients <stx-clients/index.html>`__
* `Config <stx-config/index.html>`__
* `Distributed Cloud <stx-distcloud/index.html>`__
* `Distributed Cloud Client <stx-distcloud-client/index.html>`__
* `Fault Management <stx-fault/index.html>`__
* `High Availability <stx-ha/index.html>`__
* `Horizon Plugin (GUI) <stx-gui/index.html>`__
* `Integration <stx-integ/index.html>`__
* `NFV <stx-nfv/index.html>`__
* `Software Updates <stx-update/index.html>`__
* `Upstream <stx-upstream/index.html>`__
StarlingX is provided under ... ToDo.
There are also a number of supporting projects and repositories:
Source code is maintained at the StarlingX GitHub repo.
* `Tools <stx-tools/index.html>`__
Specs
=====
`Project Specifications <specs/index.html>`__
Contents
--------
@ -25,10 +44,9 @@ Contents
installation_guide/index
developer_guide/index
API Reference <https://docs.starlingx.io/api-ref/stx-docs>
Release Notes <https://docs.starlingx.io/releasenotes>
api-ref/index
releasenotes/index
contributor/index
Project Specifications <https://docs.starlingx.io/specs>
Contributing

View File

@ -0,0 +1,19 @@
=======================
StarlingX Release Notes
=======================
Project-specific Release Notes:
* `Bare Metal <stx-metal/index.html>`__
* `Clients <stx-clients/index.html>`__
* `Configuration <stx-config/index.html>`__
* `Distributed Cloud <stx-distcloud/index.html>`__
* `Distributed Cloud Client <stx-distcloud-client/index.html>`__
* `Fault Management <stx-fault/index.html>`__
* `High Availability <stx-ha/index.html>`__
* `Horizon Plugin (GUI) <stx-gui/index.html>`__
* `Integration <stx-integ/index.html>`__
* `NFV <stx-nfv/index.html>`__
* `Software Updates <stx-update/index.html>`__
* `Tools <stx-tools/index.html>`__
* `Upstream <stx-upstream/index.html>`__

View File

@ -1,5 +1,5 @@
[tox]
envlist = linters
envlist = docs,linters
minversion = 2.3
skipsdist = True