Commit 9c337fb4 authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Update the API documentation.

parent 16b64c87
......@@ -13,3 +13,5 @@ Functions
:toctree: generated/
INHIBIT_CASCADE_DELETE
ON_CREATE_LISTS2
ON_UPDATE_LISTS2
# -*- coding: utf-8 -*-
#
# track_event api documentation build configuration file, created by
# plugin_event api documentation build configuration file, created by
# sphinx-quickstart on Sat Apr 11 11:17:03 2015.
#
# This file is execfile()d with the current directory set to its containing dir.
......@@ -78,9 +78,9 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
app = 'track_events'
app = 'plugin_event'
now = datetime.now()
project = u'track_events API'
project = u'plugin_event API'
copyright = u'2012-%s, R. Le Gac, licensed under CeCILL' % now.year
author = u'R. Le Gac'
......
Dataframes
-----------
A collection of classes and functions to build and to manipulate the sources.
.. currentmodule:: plugin_event
.. autosummary::
:toctree: generated/
db2df
debug_df
get_items
get_items_per_year
get_items_small
get_items_small_per_year
get_objectlike_items
get_objectlike_items_per_year
get_peoplelike_items
get_peoplelike_items_per_year
get_people_per_year
normalize_history_data
query_history
Timer
to_extjs_gridcolumns
\ No newline at end of file
plugin_event.Report.lists
=========================
.. currentmodule:: plugin_event
.. automethod:: Report.lists
\ No newline at end of file
plugin_event.Report.graphs
plugin_event.Report.lists2
==========================
.. currentmodule:: plugin_event
.. automethod:: Report.graphs
\ No newline at end of file
.. automethod:: Report.lists2
\ No newline at end of file
plugin_event.Report.metrics2d
=============================
.. currentmodule:: plugin_event
.. automethod:: Report.metrics2d
\ No newline at end of file
plugin_event.Metric1D.to_store
plugin_event.Report.metrics2d2
==============================
.. currentmodule:: plugin_event
.. automethod:: Metric1D.to_store
\ No newline at end of file
.. automethod:: Report.metrics2d2
\ No newline at end of file
......@@ -12,8 +12,9 @@ plugin_event.BaseReport
.. autosummary::
:toctree: report/
~BaseReport.to_df
~BaseReport.get_grid_configuration
~BaseReport.get_store_configuration
~BaseReport.get_title
......
plugin_event.EvtSelector
========================
.. currentmodule:: plugin_event
.. autoclass:: EvtSelector
:show-inheritance:
.. rubric:: Methods
.. autosummary::
:toctree: selector/
~EvtSelector.query
~EvtSelector.reset_extra_queries
......@@ -11,7 +11,8 @@ plugin_event.Graph
.. autosummary::
:toctree: report/
~Graph.to_df
~Graph.bar_like
~Graph.line_like
~Graph.to_pdf
~Graph.to_png
~Graph.to_svg
......
......@@ -11,10 +11,6 @@ plugin_event.List
.. autosummary::
:toctree: report/
~List.to_df
~List.to_grid
~List.to_store
......
......@@ -11,9 +11,7 @@ plugin_event.Metric2D
.. autosummary::
:toctree: report/
~Metric2D.to_df
~Metric2D.to_grid
~Metric2D.to_store
~Metric2D.summaries
......
plugin_event.BaseReport.to_df
plugin_event.ON_CREATE_LISTS2
=============================
.. currentmodule:: plugin_event
.. automethod:: BaseReport.to_df
\ No newline at end of file
.. autofunction:: ON_CREATE_LISTS2
\ No newline at end of file
plugin_event.Metric1D.to_grid
plugin_event.ON_UPDATE_LISTS2
=============================
.. currentmodule:: plugin_event
.. automethod:: Metric1D.to_grid
\ No newline at end of file
.. autofunction:: ON_UPDATE_LISTS2
\ No newline at end of file
......@@ -12,10 +12,8 @@ plugin_event.EvtModelReport
:toctree: model/
~Report.define_tables
~Report.graphs
~Report.lists
~Report.metrics1d
~Report.metrics2d
~Report.lists2
~Report.metrics2d2
~Report.tables
......
......@@ -12,10 +12,8 @@ plugin_event.ReportUi
:toctree: ui/
~ReportUi.define
~ReportUi.graphs
~ReportUi.lists
~ReportUi.metrics1d
~ReportUi.metrics2d
~ReportUi.lists2
~ReportUi.metrics2d2
......
plugin_event.SelectorActiveItems
================================
.. currentmodule:: plugin_event
.. autoclass:: SelectorActiveItems
:show-inheritance:
.. rubric:: Methods
.. autosummary::
:toctree: selector/
~SelectorActiveItems.get_years
~SelectorActiveItems.query
~SelectorActiveItems.reset_period
~SelectorActiveItems.set_year
plugin_event.Metric1D
=====================
plugin_event.Timer
==================
.. currentmodule:: plugin_event
.. autoclass:: Metric1D
:show-inheritance:
.. autoclass:: Timer
.. automethod:: __init__
.. rubric:: Methods
.. autosummary::
:toctree: report/
~Metric1D.to_df
~Metric1D.to_grid
~Metric1D.to_store
~Timer.__init__
\ No newline at end of file
......@@ -15,11 +15,9 @@ plugin_event.ViewportUi
~ViewportUi.app_node
~ViewportUi.configure_node
~ViewportUi.event_node
~ViewportUi.graph_node
~ViewportUi.help_node
~ViewportUi.list_node
~ViewportUi.meta_node
~ViewportUi.metric1d_node
~ViewportUi.metric2d_node
~ViewportUi.object_node
......
plugin_event.bicolor
====================
.. currentmodule:: plugin_event
.. autofunction:: bicolor
\ 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