diff options
| author | YAMAMOTO Takashi <yamamoto@valinux.co.jp> | 2014-01-27 15:31:20 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2014-01-27 22:22:10 +0900 |
| commit | d5c2c1f2e38476d043ff4f8e65f00f9de0c913af (patch) | |
| tree | 38dc1df517113cb1c30306f3883dcdf4f4c35ed2 /doc/source/api_ref.rst | |
| parent | bd235f1847d295b6d960981f03681db9d0dcc9c5 (diff) | |
doc: improve RyuApp documentation
This includes a small code change; the default value of OFP_VERIONS
was changed to None from the lack of the attribute. No functional
changes are intended by this.
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'doc/source/api_ref.rst')
| -rw-r--r-- | doc/source/api_ref.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/source/api_ref.rst b/doc/source/api_ref.rst index ed2fbce5..cc0aad20 100644 --- a/doc/source/api_ref.rst +++ b/doc/source/api_ref.rst @@ -1,7 +1,15 @@ +.. _api_ref: ******************************* Ryu API Reference ******************************* +.. XXX list all members explicitly to workaround a sphinx bug +.. XXX https://bitbucket.org/birkenfeld/sphinx/issue/1362 + +.. py:currentmodule:: ryu.base.app_manager +.. autoclass:: ryu.base.app_manager.RyuApp + :members: OFP_VERSIONS,_CONTEXTS,_EVENTS,close,context_iteritems,reply_to_request,send_event,send_event_to_observers,send_request,start + .. automodule:: ryu.controller.dpset :members: |