2016-03-03 16:00:46 |
David TARDIVEL |
bug |
|
|
added bug |
2016-03-04 08:26:44 |
David TARDIVEL |
summary |
implement a doc directive to automatically update API HTML doc from source code |
implement a doc directive to automatically update API RST doc from source code |
|
2016-03-14 13:56:43 |
Antoine Cabot |
watcher: milestone |
|
mitaka-rc-final |
|
2016-03-21 08:28:11 |
David TARDIVEL |
watcher: status |
New |
Triaged |
|
2016-03-23 16:24:38 |
Antoine Cabot |
watcher: milestone |
mitaka-rc-final |
newton-1 |
|
2016-05-31 07:14:20 |
Antoine Cabot |
watcher: milestone |
newton-1 |
newton-2 |
|
2016-07-06 12:02:24 |
Antoine Cabot |
watcher: milestone |
newton-2 |
newton-3 |
|
2016-09-08 08:18:53 |
tamil vanan |
watcher: assignee |
|
tamil vanan (tamilhce) |
|
2016-09-09 07:07:55 |
tamil vanan |
watcher: assignee |
tamil vanan (tamilhce) |
|
|
2016-11-03 10:06:51 |
Vincent Françoise |
description |
Some part of RST doc is automatically generated from source code, by using watcher doc directive (https://github.com/openstack/watcher/blob/master/watcher/doc.py)
RST API page is, for now, created statitically. It should be great to built it dynamically. |
Some part of RST doc is automatically generated from source code, by using watcher doc directive (https://github.com/openstack/watcher/blob/master/doc/ext/term.py)
RST API page is, for now, created statitically. It should be great to built it dynamically. |
|
2016-11-03 10:12:23 |
David TARDIVEL |
description |
Some part of RST doc is automatically generated from source code, by using watcher doc directive (https://github.com/openstack/watcher/blob/master/doc/ext/term.py)
RST API page is, for now, created statitically. It should be great to built it dynamically. |
Some part of RST doc is automatically generated from source code, by using watcher doc directive (https://github.com/openstack/watcher/blob/master/doc/ext/term.py)
RST API page is, for now, created statitically. It should be great to built it dynamically (file: doc/source/webapi/v1.rst) |
|
2016-11-03 10:16:37 |
Vincent Françoise |
description |
Some part of RST doc is automatically generated from source code, by using watcher doc directive (https://github.com/openstack/watcher/blob/master/doc/ext/term.py)
RST API page is, for now, created statitically. It should be great to built it dynamically (file: doc/source/webapi/v1.rst) |
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/). |
|
2016-11-03 10:16:42 |
Vincent Françoise |
tags |
|
doc |
|
2016-11-03 10:19:45 |
Vincent Françoise |
summary |
implement a doc directive to automatically update API RST doc from source code |
Document the Watcher API using the API Ref |
|
2017-02-16 19:24:24 |
Chris Spencer |
watcher: assignee |
|
Chris Spencer (christopher-m-spencer) |
|
2017-04-14 20:13:28 |
Chris Spencer |
watcher: assignee |
Chris Spencer (christopher-m-spencer) |
|
|
2017-04-21 04:49:51 |
aditi sharma |
watcher: assignee |
|
aditi sharma (adi-sky17) |
|
2017-07-31 13:37:23 |
Alexander Chadin |
watcher: status |
Triaged |
Invalid |
|