Commit 1f6837c8 authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Update the API documentation.

parent ccb290f4
plugin_event.Event.get_source
=============================
.. currentmodule:: plugin_event
.. automethod:: Event.get_source
\ No newline at end of file
plugin_event.Selector.selector
plugin_event.Event.get_sources
==============================
.. currentmodule:: plugin_event
.. automethod:: Selector.selector
\ No newline at end of file
.. automethod:: Event.get_sources
\ No newline at end of file
plugin_event.Event.register_source
==================================
.. currentmodule:: plugin_event
.. automethod:: Event.register_source
\ No newline at end of file
plugin_event.SelectorUi.selector
plugin_event.Event.register_sources
===================================
.. currentmodule:: plugin_event
.. automethod:: SelectorUi.selector
\ No newline at end of file
.. automethod:: Event.register_sources
\ No newline at end of file
plugin_event.ViewportUi.object_node
plugin_event.Selector.selector_list
===================================
.. currentmodule:: plugin_event
.. automethod:: ViewportUi.object_node
\ No newline at end of file
.. automethod:: Selector.selector_list
\ No newline at end of file
plugin_event.Selector.selector_metric2d
=======================================
.. currentmodule:: plugin_event
.. automethod:: Selector.selector_metric2d
\ No newline at end of file
plugin_event.Selector.selector_source
=====================================
.. currentmodule:: plugin_event
.. automethod:: Selector.selector_source
\ No newline at end of file
......@@ -12,6 +12,11 @@ plugin_event.Event
:toctree: model/
~Event.define_paths
~Event.get_source
~Event.get_sources
~Event.register_source
~Event.register_sources
......
......@@ -12,7 +12,9 @@ plugin_event.EvtModelSelector
:toctree: model/
~Selector.define_tables
~Selector.selector
~Selector.selector_list
~Selector.selector_metric2d
~Selector.selector_source
......
......@@ -13,7 +13,9 @@ plugin_event.SelectorUi
:toctree: ui/
~SelectorUi.define
~SelectorUi.selector
~SelectorUi.selector_list
~SelectorUi.selector_metric2d
~SelectorUi.selector_source
......
plugin_event.Source
====================
.. currentmodule:: plugin_event
.. autoclass:: Source
:show-inheritance:
.. rubric:: Methods
.. autosummary::
:toctree: report/
......@@ -19,7 +19,8 @@ plugin_event.ViewportUi
~ViewportUi.list_node
~ViewportUi.meta_node
~ViewportUi.metric2d_node
~ViewportUi.object_node
~ViewportUi.people_object_node
~ViewportUi.source_node
......
plugin_event.SelectorUi.selector_list
=====================================
.. currentmodule:: plugin_event
.. automethod:: SelectorUi.selector_list
\ No newline at end of file
plugin_event.SelectorUi.selector_metric2d
=========================================
.. currentmodule:: plugin_event
.. automethod:: SelectorUi.selector_metric2d
\ No newline at end of file
plugin_event.SelectorUi.selector_source
=======================================
.. currentmodule:: plugin_event
.. automethod:: SelectorUi.selector_source
\ No newline at end of file
plugin_event.ViewportUi.people_object_node
==========================================
.. currentmodule:: plugin_event
.. automethod:: ViewportUi.people_object_node
\ No newline at end of file
plugin_event.ViewportUi.source_node
===================================
.. currentmodule:: plugin_event
.. automethod:: ViewportUi.source_node
\ No newline at end of file
......@@ -14,4 +14,5 @@ A collection of classes to build report: *list*, *graph* or
BaseReport
Graph
List
Metric2D
\ No newline at end of file
Metric2D
Source
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment