Document the Watcher API using the API Ref

Bug #1552769 reported by David TARDIVEL on 2016-03-03
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
watcher
Wishlist
aditi sharma

Bug Description

The API Reference doc (https://github.com/openstack/watcher/blob/master/doc/source/webapi/v1.rst) is automatically generated from source code, by using directives.

The idea here would be to overhaul this part of the documentation to do it like Nova or Ironic (see https://github.com/openstack/ironic/tree/master/api-ref and http://developer.openstack.org/api-ref/baremetal/).

Tags: doc Edit Tag help
summary: - implement a doc directive to automatically update API HTML doc from
+ implement a doc directive to automatically update API RST doc from
source code
Changed in watcher:
milestone: none → mitaka-rc-final
Changed in watcher:
status: New → Triaged
Changed in watcher:
milestone: mitaka-rc-final → newton-1
Changed in watcher:
milestone: newton-1 → newton-2
Changed in watcher:
milestone: newton-2 → newton-3
tamil vanan (tamilhce) on 2016-09-08
Changed in watcher:
assignee: nobody → tamil vanan (tamilhce)
tamil vanan (tamilhce) on 2016-09-09
Changed in watcher:
assignee: tamil vanan (tamilhce) → nobody
description: updated
description: updated
description: updated
tags: added: doc
summary: - implement a doc directive to automatically update API RST doc from
- source code
+ Document the Watcher API using the API Ref
Changed in watcher:
assignee: nobody → Chris Spencer (christopher-m-spencer)
Changed in watcher:
assignee: Chris Spencer (christopher-m-spencer) → nobody
aditi sharma (adi-sky17) on 2017-04-21
Changed in watcher:
assignee: nobody → aditi sharma (adi-sky17)
Alexander Chadin (joker946) wrote :

We have rebuilt all docs in accordance with https://etherpad.openstack.org/p/doc-migration-tracking

Changed in watcher:
status: Triaged → Invalid
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers