Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Open sidebar
tev
plugin_event
Commits
9c337fb4
Commit
9c337fb4
authored
Mar 22, 2017
by
LE GAC Renaud
Browse files
Update the API documentation.
parent
16b64c87
Changes
71
Hide whitespace changes
Inline
Side-by-side
Showing
20 changed files
with
77 additions
and
81 deletions
+77
-81
docs/api/callback.rst
docs/api/callback.rst
+2
-0
docs/api/conf.py
docs/api/conf.py
+3
-3
docs/api/dataframes.rst
docs/api/dataframes.rst
+26
-0
docs/api/generated/model/plugin_event.Report.lists.rst
docs/api/generated/model/plugin_event.Report.lists.rst
+0
-6
docs/api/generated/model/plugin_event.Report.lists2.rst
docs/api/generated/model/plugin_event.Report.lists2.rst
+2
-2
docs/api/generated/model/plugin_event.Report.metrics2d.rst
docs/api/generated/model/plugin_event.Report.metrics2d.rst
+0
-6
docs/api/generated/model/plugin_event.Report.metrics2d2.rst
docs/api/generated/model/plugin_event.Report.metrics2d2.rst
+2
-2
docs/api/generated/plugin_event.BaseReport.rst
docs/api/generated/plugin_event.BaseReport.rst
+3
-2
docs/api/generated/plugin_event.EvtSelector.rst
docs/api/generated/plugin_event.EvtSelector.rst
+0
-15
docs/api/generated/plugin_event.Graph.rst
docs/api/generated/plugin_event.Graph.rst
+2
-1
docs/api/generated/plugin_event.List.rst
docs/api/generated/plugin_event.List.rst
+0
-4
docs/api/generated/plugin_event.Metric2D.rst
docs/api/generated/plugin_event.Metric2D.rst
+1
-3
docs/api/generated/plugin_event.ON_CREATE_LISTS2.rst
docs/api/generated/plugin_event.ON_CREATE_LISTS2.rst
+2
-2
docs/api/generated/plugin_event.ON_UPDATE_LISTS2.rst
docs/api/generated/plugin_event.ON_UPDATE_LISTS2.rst
+2
-2
docs/api/generated/plugin_event.Report.rst
docs/api/generated/plugin_event.Report.rst
+2
-4
docs/api/generated/plugin_event.ReportUi.rst
docs/api/generated/plugin_event.ReportUi.rst
+2
-4
docs/api/generated/plugin_event.SelectorActiveItems.rst
docs/api/generated/plugin_event.SelectorActiveItems.rst
+0
-23
docs/api/generated/plugin_event.Timer.rst
docs/api/generated/plugin_event.Timer.rst
+22
-0
docs/api/generated/plugin_event.ViewportUi.rst
docs/api/generated/plugin_event.ViewportUi.rst
+0
-2
docs/api/generated/plugin_event.bicolor.rst
docs/api/generated/plugin_event.bicolor.rst
+6
-0
No files found.
docs/api/callback.rst
View file @
9c337fb4
...
...
@@ -13,3 +13,5 @@ Functions
:toctree: generated/
INHIBIT_CASCADE_DELETE
ON_CREATE_LISTS2
ON_UPDATE_LISTS2
docs/api/conf.py
View file @
9c337fb4
# -*- 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
_event
s
'
app
=
'
plugin
_event'
now
=
datetime
.
now
()
project
=
u
'
track
_event
s
API'
project
=
u
'
plugin
_event API'
copyright
=
u
'2012-%s, R. Le Gac, licensed under CeCILL'
%
now
.
year
author
=
u
'R. Le Gac'
...
...
docs/api/dataframes.rst
0 → 100644
View file @
9c337fb4
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
docs/api/generated/model/plugin_event.Report.lists.rst
deleted
100644 → 0
View file @
16b64c87
plugin_event.Report.lists
=========================
.. currentmodule:: plugin_event
.. automethod:: Report.lists
\ No newline at end of file
docs/api/generated/model/plugin_event.Report.
graphs
.rst
→
docs/api/generated/model/plugin_event.Report.
lists2
.rst
View file @
9c337fb4
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
docs/api/generated/model/plugin_event.Report.metrics2d.rst
deleted
100644 → 0
View file @
16b64c87
plugin_event.Report.metrics2d
=============================
.. currentmodule:: plugin_event
.. automethod:: Report.metrics2d
\ No newline at end of file
docs/api/generated/
report
/plugin_event.
Metric1D.to_store
.rst
→
docs/api/generated/
model
/plugin_event.
Report.metrics2d2
.rst
View file @
9c337fb4
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
docs/api/generated/plugin_event.BaseReport.rst
View file @
9c337fb4
...
...
@@ -12,8 +12,9 @@ plugin_event.BaseReport
.. autosummary::
:toctree: report/
~BaseReport.to_df
~BaseReport.get_grid_configuration
~BaseReport.get_store_configuration
~BaseReport.get_title
...
...
docs/api/generated/plugin_event.EvtSelector.rst
deleted
100644 → 0
View file @
16b64c87
plugin_event.EvtSelector
========================
.. currentmodule:: plugin_event
.. autoclass:: EvtSelector
:show-inheritance:
.. rubric:: Methods
.. autosummary::
:toctree: selector/
~EvtSelector.query
~EvtSelector.reset_extra_queries
docs/api/generated/plugin_event.Graph.rst
View file @
9c337fb4
...
...
@@ -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
...
...
docs/api/generated/plugin_event.List.rst
View file @
9c337fb4
...
...
@@ -11,10 +11,6 @@ plugin_event.List
.. autosummary::
:toctree: report/
~List.to_df
~List.to_grid
~List.to_store
...
...
docs/api/generated/plugin_event.Metric2D.rst
View file @
9c337fb4
...
...
@@ -11,9 +11,7 @@ plugin_event.Metric2D
.. autosummary::
:toctree: report/
~Metric2D.to_df
~Metric2D.to_grid
~Metric2D.to_store
~Metric2D.summaries
...
...
docs/api/generated/
report/
plugin_event.
BaseReport.to_df
.rst
→
docs/api/generated/plugin_event.
ON_CREATE_LISTS2
.rst
View file @
9c337fb4
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
docs/api/generated/
report/
plugin_event.
Metric1D.to_grid
.rst
→
docs/api/generated/plugin_event.
ON_UPDATE_LISTS2
.rst
View file @
9c337fb4
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
docs/api/generated/plugin_event.Report.rst
View file @
9c337fb4
...
...
@@ -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
...
...
docs/api/generated/plugin_event.ReportUi.rst
View file @
9c337fb4
...
...
@@ -12,10 +12,8 @@ plugin_event.ReportUi
:toctree: ui/
~ReportUi.define
~ReportUi.graphs
~ReportUi.lists
~ReportUi.metrics1d
~ReportUi.metrics2d
~ReportUi.lists2
~ReportUi.metrics2d2
...
...
docs/api/generated/plugin_event.SelectorActiveItems.rst
deleted
100644 → 0
View file @
16b64c87
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
docs/api/generated/plugin_event.
Metric1D
.rst
→
docs/api/generated/plugin_event.
Timer
.rst
View file @
9c337fb4
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
docs/api/generated/plugin_event.ViewportUi.rst
View file @
9c337fb4
...
...
@@ -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
...
...
docs/api/generated/plugin_event.bicolor.rst
0 → 100644
View file @
9c337fb4
plugin_event.bicolor
====================
.. currentmodule:: plugin_event
.. autofunction:: bicolor
\ No newline at end of file
Prev
1
2
3
4
Next
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment