Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
P
plugin_dbui
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
w2pext
plugin_dbui
Commits
46c0d7bc
Commit
46c0d7bc
authored
9 years ago
by
legac
Browse files
Options
Downloads
Patches
Plain Diff
First tentative to create the index using autosummary.
parent
e98b93fc
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/api/conf.py
+3
-1
3 additions, 1 deletion
docs/api/conf.py
docs/api/index.rst
+70
-3
70 additions, 3 deletions
docs/api/index.rst
with
73 additions
and
4 deletions
docs/api/conf.py
+
3
−
1
View file @
46c0d7bc
...
...
@@ -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
This diff is collapsed.
Click to expand it.
docs/api/index.rst
+
70
−
3
View file @
46c0d7bc
...
...
@@ -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
==================
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment