Skip to content
Snippets Groups Projects
Commit 46c0d7bc authored by legac's avatar legac
Browse files

First tentative to create the index using autosummary.

parent e98b93fc
No related branches found
No related tags found
No related merge requests found
......@@ -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
......@@ -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
==================
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment