From 9d2a15ec3aae39275ef4be55976aa39333fb871e Mon Sep 17 00:00:00 2001
From: Renaud Le Gac <legac@cppm.in2p3.fr>
Date: Tue, 14 Apr 2015 12:52:38 +0200
Subject: [PATCH] Finalise the index.rst using autosummary.
---
.gitignore | 1 +
docs/api/constant.rst | 12 +++
docs/api/controller.rst | 48 ++++++++++
docs/api/database_model.rst | 35 +++++++
docs/api/index.rst | 83 ++---------------
docs/api/modules.rst | 7 --
docs/api/plugin_dbui.rst | 163 ---------------------------------
docs/api/service_exception.rst | 76 +++++++++++++++
docs/api/user_interface.rst | 134 +++++++++++++++++++++++++++
9 files changed, 315 insertions(+), 244 deletions(-)
create mode 100644 docs/api/constant.rst
create mode 100644 docs/api/controller.rst
create mode 100644 docs/api/database_model.rst
delete mode 100644 docs/api/modules.rst
delete mode 100644 docs/api/plugin_dbui.rst
create mode 100644 docs/api/service_exception.rst
create mode 100644 docs/api/user_interface.rst
diff --git a/.gitignore b/.gitignore
index dff1b301..99ba0afd 100755
--- a/.gitignore
+++ b/.gitignore
@@ -8,6 +8,7 @@ cron/
_build/
databases/
errors/
+generated/
httpserver.log
private/
sessions/
diff --git a/docs/api/constant.rst b/docs/api/constant.rst
new file mode 100644
index 00000000..ea036a60
--- /dev/null
+++ b/docs/api/constant.rst
@@ -0,0 +1,12 @@
+
+Constants
+---------
+
+ =============== === ================================================
+ CALLBACK_ERRORS str ``_callback_errors``
+ DBUI str ``Dbui``
+ INLINE_ALERT str ``<script>Ext.Msg.alert('%s', '%s');</script>``
+ UNDEF str ``undefined``
+ UNDEF_ID int ``1``
+ UNKNOWN str ``???``
+ =============== === ================================================
diff --git a/docs/api/controller.rst b/docs/api/controller.rst
new file mode 100644
index 00000000..b26e5679
--- /dev/null
+++ b/docs/api/controller.rst
@@ -0,0 +1,48 @@
+
+Controller
+----------
+
+Selector
+^^^^^^^^
+
+.. currentmodule:: plugin_dbui.selector
+
+.. autosummary::
+ :toctree: generated/
+
+ Selector
+
+Helper functions
+^^^^^^^^^^^^^^^^
+
+.. currentmodule:: plugin_dbui.helper
+
+.. autosummary::
+ :toctree: generated/
+
+ as_list
+ close_user_session
+ decode_field
+ dummy_row
+ encode_field
+ encode_validator_errors
+ get_all_tables
+ get_create_id
+ get_field_validators
+ get_file_paths
+ get_foreign_field
+ get_id
+ get_language
+ get_plugin_path
+ get_reference_paths
+ get_set_field
+ get_script_path
+ get_set_field
+ get_store_id
+ get_versions
+ get_where_query
+ is_foreign_field
+ is_mathjax
+ is_set_field
+ is_table_with_foreign_fields
+ rows_serializer
diff --git a/docs/api/database_model.rst b/docs/api/database_model.rst
new file mode 100644
index 00000000..dbb3f0f1
--- /dev/null
+++ b/docs/api/database_model.rst
@@ -0,0 +1,35 @@
+
+Database model
+--------------
+
+Callbacks
+^^^^^^^^^
+
+.. currentmodule:: plugin_dbui.callback
+
+.. autosummary::
+ :toctree: generated/
+
+ INHIBIT_DELETE_UNDEF
+ INHIBIT_UPDATE_UNDEF
+
+Filters
+^^^^^^^
+
+.. currentmodule:: plugin_dbui.filters
+
+.. autosummary::
+ :toctree: generated/
+
+ CLEAN_COMMA
+ CLEAN_SPACES
+
+Validators
+^^^^^^^^^^
+
+.. currentmodule:: plugin_dbui.validator
+
+.. autosummary::
+ :toctree: generated/
+
+ IS_IN_USET
diff --git a/docs/api/index.rst b/docs/api/index.rst
index 38f43214..f3ec703b 100644
--- a/docs/api/index.rst
+++ b/docs/api/index.rst
@@ -3,82 +3,17 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to plugin_dbui's documentation!
-=======================================
+Documentation contents
+======================
-Contents:
+.. toctree::
+ :maxdepth: 2
-.. currentmodule:: plugin_dbui
-
-
-The main class
-==============
-
-Constants
----------
-
- ========= === =============
- UNDEF str ``undefined``
- UNDEF_ID int ``1``
- UNKNOWN str ``???``
- ========= === =============
-
-Helpers functions
------------------
-
-.. currentmodule:: plugin_dbui.helper
-
-.. autosummary::
- :toctree: generated/
-
- get_id
-
-Modifiers
----------
-
-.. currentmodule:: plugin_dbui.fieldsmodifier
-
-.. autosummary::
- :toctree: generated/
-
- FieldsModifier
-
-.. currentmodule:: plugin_dbui.formmodifier
-
-.. autosummary::
- :toctree: generated/
-
- FormModifier
-
-.. currentmodule:: plugin_dbui.gridmodifier
-
-.. autosummary::
- :toctree: generated/
-
- GridModifier
-
-Validators
-----------
-
-.. currentmodule:: plugin_dbui
-
-Callbacks
----------
-
-Database service
-----------------
-
-.. autosummary::
- :toctree: generated/
-
- dbsvc.DbSvc
- directsvc.DirectSvc
-
-Base classes
-------------
-
-Exceptions
-----------
+ constant
+ database_model
+ user_interface
+ controller
+ service_exception
Indices and tables
==================
diff --git a/docs/api/modules.rst b/docs/api/modules.rst
deleted file mode 100644
index bacff267..00000000
--- a/docs/api/modules.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-plugin_dbui
-===========
-
-.. toctree::
- :maxdepth: 4
-
- plugin_dbui
diff --git a/docs/api/plugin_dbui.rst b/docs/api/plugin_dbui.rst
deleted file mode 100644
index 4a107471..00000000
--- a/docs/api/plugin_dbui.rst
+++ /dev/null
@@ -1,163 +0,0 @@
-plugin_dbui Package
-===================
-
-:mod:`plugin_dbui` Package
---------------------------
-
-.. automodule:: plugin_dbui.__init__
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`basesvc` Module
----------------------
-
-.. automodule:: plugin_dbui.basesvc
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`callback` Module
-----------------------
-
-.. automodule:: plugin_dbui.callback
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`constant` Module
-----------------------
-
-.. automodule:: plugin_dbui.constant
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`converter` Module
------------------------
-
-.. automodule:: plugin_dbui.converter
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`dbsvc` Module
--------------------
-
-.. automodule:: plugin_dbui.dbsvc
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`directsvc` Module
------------------------
-
-.. automodule:: plugin_dbui.directsvc
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`extjs` Module
--------------------
-
-.. automodule:: plugin_dbui.extjs
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`fieldsmodifier` Module
-----------------------------
-
-.. automodule:: plugin_dbui.fieldsmodifier
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`filters` Module
----------------------
-
-.. automodule:: plugin_dbui.filters
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`formmodifier` Module
---------------------------
-
-.. automodule:: plugin_dbui.formmodifier
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`gridmodifier` Module
---------------------------
-
-.. automodule:: plugin_dbui.gridmodifier
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`helper` Module
---------------------
-
-.. automodule:: plugin_dbui.helper
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`mapper` Module
---------------------
-
-.. automodule:: plugin_dbui.mapper
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`modifier` Module
-----------------------
-
-.. automodule:: plugin_dbui.modifier
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`navtree` Module
----------------------
-
-.. automodule:: plugin_dbui.navtree
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`selector` Module
-----------------------
-
-.. automodule:: plugin_dbui.selector
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`storemodifier` Module
----------------------------
-
-.. automodule:: plugin_dbui.storemodifier
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`validator` Module
------------------------
-
-.. automodule:: plugin_dbui.validator
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`viewportmodifier` Module
-------------------------------
-
-.. automodule:: plugin_dbui.viewportmodifier
- :members:
- :undoc-members:
- :show-inheritance:
-
diff --git a/docs/api/service_exception.rst b/docs/api/service_exception.rst
new file mode 100644
index 00000000..1d93449b
--- /dev/null
+++ b/docs/api/service_exception.rst
@@ -0,0 +1,76 @@
+
+Services, exception and base classes
+------------------------------------
+
+Services
+^^^^^^^^
+
+.. currentmodule:: plugin_dbui.dbsvc
+
+.. autosummary::
+ :toctree: generated/
+
+ DbSvc
+
+.. currentmodule:: plugin_dbui.directsvc
+
+.. autosummary::
+ :toctree: generated/
+
+ DirectSvc
+
+Exceptions
+^^^^^^^^^^
+
+.. currentmodule:: plugin_dbui.dbsvc
+
+.. autosummary::
+ :toctree: generated/
+
+ DbSvcException
+
+.. currentmodule:: plugin_dbui.extjs
+
+.. autosummary::
+ :toctree: generated/
+
+ ExtJSException
+
+.. currentmodule:: plugin_dbui.gridmodifier
+
+.. autosummary::
+ :toctree: generated/
+
+ GridModifierException
+
+.. currentmodule:: plugin_dbui.viewportmodifier
+
+.. autosummary::
+ :toctree: generated/
+
+ ViewportModifierException
+
+Base classes
+^^^^^^^^^^^^
+
+.. currentmodule:: plugin_dbui.basesvc
+
+.. autosummary::
+ :toctree: generated/
+
+ BaseSvc
+
+.. currentmodule:: plugin_dbui.extjs
+
+.. autosummary::
+ :toctree: generated/
+
+ Base
+
+.. currentmodule:: plugin_dbui.modifier
+
+.. autosummary::
+ :toctree: generated/
+
+ Modifier
+
diff --git a/docs/api/user_interface.rst b/docs/api/user_interface.rst
new file mode 100644
index 00000000..0e7cdb91
--- /dev/null
+++ b/docs/api/user_interface.rst
@@ -0,0 +1,134 @@
+
+User interface
+--------------
+
+Field
+^^^^^
+
+.. currentmodule:: plugin_dbui.fieldsmodifier
+
+.. autosummary::
+ :toctree: generated/
+
+ FieldsModifier
+
+
+Form
+^^^^
+
+.. currentmodule:: plugin_dbui.formmodifier
+
+.. autosummary::
+ :toctree: generated/
+
+ configure_forms
+ FormModifier
+
+.. currentmodule:: plugin_dbui.mapper
+
+.. autosummary::
+ :toctree: generated/
+
+ map_default
+ map_tabpanel
+
+Grid
+^^^^
+
+.. currentmodule:: plugin_dbui.gridmodifier
+
+.. autosummary::
+ :toctree: generated/
+
+ configure_grids
+ GridModifier
+
+Store
+^^^^^
+
+.. currentmodule:: plugin_dbui.storemodifier
+
+.. autosummary::
+ :toctree: generated/
+
+ AddStore
+ StoreModifier
+
+Viewport
+^^^^^^^^
+
+.. currentmodule:: plugin_dbui.navtree
+
+.. autosummary::
+ :toctree: generated/
+
+ Node
+
+.. currentmodule:: plugin_dbui.viewportmodifier
+
+.. autosummary::
+ :toctree: generated/
+
+ ViewportModifier
+
+Convert database fields to widgets
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. currentmodule:: plugin_dbui.converter
+
+.. autosummary::
+ :toctree: generated/
+
+ to_field
+ to_fields
+ to_formPanel
+ to_gridColumn
+ to_gridColumnModel
+ to_gridFilter
+ to_gridPanel
+ to_jsonstore
+ to_model
+ to_panelWithUrlSelector
+ to_treeNodes
+ to_viewport
+
+Ext JS widget mappings
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. currentmodule:: plugin_dbui.extjs
+
+.. autosummary::
+ :toctree: generated/
+
+ ArrayStore
+ CheckBox
+ ComboBox
+ DirectStore
+ Field
+ FieldAceEditor
+ FieldContainer
+ FieldDate
+ FieldDict
+ FieldList
+ FieldNumber
+ FieldSet
+ FieldText
+ FieldTextArea
+ FieldTime
+ FormPanel
+ GridColumn
+ GridColumnModel
+ GridFilter
+ GridPanel
+ GridRowNumberer
+ GridTemplateColumn
+ GridWithFilter
+ JsonStore
+ Model
+ Panel
+ PanelWithUrlSelector
+ Store
+ TabPanel
+ Viewport
+ Window
+ XmlStore
\ No newline at end of file
--
GitLab