Commit 51f53677 authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Migrate the api documentation.

parent 94b05276
......@@ -7,9 +7,9 @@ A collections of functions to be call before a database operation is completed.
Functions
^^^^^^^^^
.. currentmodule:: callbacks
.. currentmodule:: plugin_event
.. autosummary::
:toctree: generated/
~INHIBIT_CASCADE_DELETE
INHIBIT_CASCADE_DELETE
report_objects.BaseReport.to_df
===============================
.. currentmodule:: report_objects
.. automethod:: BaseReport.to_df
\ No newline at end of file
callbacks.INHIBIT_CASCADE_DELETE
================================
.. currentmodule:: callbacks
.. autofunction:: INHIBIT_CASCADE_DELETE
\ No newline at end of file
report_objects.Graph.to_df
==========================
.. currentmodule:: report_objects
.. automethod:: Graph.to_df
\ No newline at end of file
report_objects.Graph.to_pdf
===========================
.. currentmodule:: report_objects
.. automethod:: Graph.to_pdf
\ No newline at end of file
report_objects.Graph.to_png
===========================
.. currentmodule:: report_objects
.. automethod:: Graph.to_png
\ No newline at end of file
report_objects.Graph.to_svg
===========================
.. currentmodule:: report_objects
.. automethod:: Graph.to_svg
\ No newline at end of file
report_objects.List.to_df
=========================
.. currentmodule:: report_objects
.. automethod:: List.to_df
\ No newline at end of file
report_objects.List.to_grid
===========================
.. currentmodule:: report_objects
.. automethod:: List.to_grid
\ No newline at end of file
report_objects.List.to_store
============================
.. currentmodule:: report_objects
.. automethod:: List.to_store
\ No newline at end of file
report_objects.Metric1D.to_df
=============================
.. currentmodule:: report_objects
.. automethod:: Metric1D.to_df
\ No newline at end of file
report_objects.Metric1D.to_grid
===============================
.. currentmodule:: report_objects
.. automethod:: Metric1D.to_grid
\ No newline at end of file
report_objects.Metric1D.to_store
================================
.. currentmodule:: report_objects
.. automethod:: Metric1D.to_store
\ No newline at end of file
report_objects.Metric2D.to_df
=============================
.. currentmodule:: report_objects
.. automethod:: Metric2D.to_df
\ No newline at end of file
report_objects.Metric2D.to_grid
===============================
.. currentmodule:: report_objects
.. automethod:: Metric2D.to_grid
\ No newline at end of file
report_objects.Metric2D.to_store
================================
.. currentmodule:: report_objects
.. automethod:: Metric2D.to_store
\ No newline at end of file
selector.MySelector.query
=========================
.. currentmodule:: selector
.. automethod:: MySelector.query
\ No newline at end of file
selector.MySelector.reset_extra_queries
=======================================
.. currentmodule:: selector
.. automethod:: MySelector.reset_extra_queries
\ No newline at end of file
report_objects.BaseReport
=========================
plugin_event.BaseReport
=======================
.. currentmodule:: report_objects
.. currentmodule:: plugin_event
.. autoclass:: BaseReport
:show-inheritance:
.. rubric:: Methods
.. autosummary::
:toctree: basereport/
:toctree: report/
~BaseReport.to_df
......
report_objects.Graph
====================
plugin_event.Graph
==================
.. currentmodule:: report_objects
.. currentmodule:: plugin_event
.. autoclass:: Graph
:show-inheritance:
.. rubric:: Methods
.. autosummary::
:toctree: graph/
:toctree: report/
~Graph.to_df
~Graph.to_pdf
......
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