ptp-notification-armada-app/doc/source/index.rst
Stone c57268ca11 api-ref html builds
rST fixes to index and api docs.

Commented out release notes job in zuul. There don't appear
to be any and it is causing failures.

Added a doc job to tox and created content pointing to api-ref.

Moved api-ref/doc/requirements.txt up one level

Added templates section to .zuul.yaml
Added api-refs env to tox.ini
Added pip requirements for sphinx builds

Signed-off-by: Stone <ronald.stone@windriver.com>
Change-Id: Ic20dfe02d40d193ce443240170f967d72899a58b
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Signed-off-by: Stone <ronald.stone@windriver.com>
2021-03-11 13:11:54 -05:00

29 lines
885 B
ReStructuredText

=============================================
StarlingX PTP Notification Armada App Project
=============================================
The starlingx/ptp-notification-armada-app project provides a subscription
service for hosted applications to receive PTP status notifications from
the StarlingX platform.
-------------
API reference
-------------
.. toctree::
:maxdepth: 1
API reference <https://docs.starlingx.io/api-ref/ptp-notification-armada-app>
-----
Links
-----
* Source: `starlingx/ptp-notification-armada-app`_
* Code review: `Gerrit`_
* Project tracking: `Storyboard`_
.. _starlingx/ptp-notification-armada-app: https://opendev.org/starlingx/ptp-notification-armada-app/
.. _Gerrit: https://review.opendev.org/#/q/project:starlingx/ptp-notification-armada-app
.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/ptp-notification-armada-app