diff --git a/docs/api/conf.py b/docs/api/conf.py index 58b1952167798091d730106e69a0bd745ff15fc4..6b8a2b40e2a3bdbb86ce3a7102436c5bc3b7bf9b 100644 --- a/docs/api/conf.py +++ b/docs/api/conf.py @@ -27,7 +27,8 @@ sys.path.insert(0, os.path.abspath('../../../web2py')) # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', @@ -250,3 +251,4 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'http://docs.python.org/2.7': None} +autosummary_generate = True diff --git a/docs/api/index.rst b/docs/api/index.rst index 2324a2b0f5ea18960fddaf50ae02505b8d545f51..38f432144c68702722de3b4aa1f7fb8ef2114f3a 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -8,10 +8,77 @@ Welcome to plugin_dbui's documentation! Contents: -.. toctree:: - :maxdepth: 2 +.. currentmodule:: plugin_dbui - 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 +---------- Indices and tables ==================