feat: add basic support for wutta-continuum
and i mean *basic* - so far.. eventually will expose version history for viewing etc. unfortunately got carried away and reorganized the api docs a little while i was at it..
This commit is contained in:
parent
24f5ee1dcc
commit
71728718d8
53 changed files with 308 additions and 76 deletions
|
@ -1,10 +0,0 @@
|
|||
|
||||
Package API
|
||||
===========
|
||||
|
||||
This is the "raw" API documentation for the ``wuttaweb`` package.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
wuttaweb/index
|
6
docs/api/wuttaweb.conf.rst
Normal file
6
docs/api/wuttaweb.conf.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
|
||||
``wuttaweb.conf``
|
||||
=================
|
||||
|
||||
.. automodule:: wuttaweb.conf
|
||||
:members:
|
6
docs/api/wuttaweb.db.continuum.rst
Normal file
6
docs/api/wuttaweb.db.continuum.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
|
||||
``wuttaweb.db.continuum``
|
||||
=========================
|
||||
|
||||
.. automodule:: wuttaweb.db.continuum
|
||||
:members:
|
6
docs/api/wuttaweb.db.sess.rst
Normal file
6
docs/api/wuttaweb.db.sess.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
|
||||
``wuttaweb.db.sess``
|
||||
====================
|
||||
|
||||
.. automodule:: wuttaweb.db.sess
|
||||
:members:
|
6
docs/api/wuttaweb.rst
Normal file
6
docs/api/wuttaweb.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
|
||||
``wuttaweb``
|
||||
============
|
||||
|
||||
.. automodule:: wuttaweb
|
||||
:members:
|
|
@ -1,38 +0,0 @@
|
|||
|
||||
``wuttaweb``
|
||||
============
|
||||
|
||||
.. automodule:: wuttaweb
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
app
|
||||
auth
|
||||
db
|
||||
forms
|
||||
forms.base
|
||||
forms.schema
|
||||
forms.widgets
|
||||
grids
|
||||
grids.base
|
||||
grids.filters
|
||||
handler
|
||||
helpers
|
||||
menus
|
||||
progress
|
||||
static
|
||||
subscribers
|
||||
util
|
||||
views
|
||||
views.auth
|
||||
views.base
|
||||
views.common
|
||||
views.essential
|
||||
views.master
|
||||
views.people
|
||||
views.progress
|
||||
views.roles
|
||||
views.settings
|
||||
views.upgrades
|
||||
views.users
|
|
@ -34,6 +34,7 @@ intersphinx_mapping = {
|
|||
'rattail-manual': ('https://rattailproject.org/docs/rattail-manual/', None),
|
||||
'webhelpers2': ('https://webhelpers2.readthedocs.io/en/latest/', None),
|
||||
'wuttjamaican': ('https://rattailproject.org/docs/wuttjamaican/', None),
|
||||
'wutta-continuum': ('https://rattailproject.org/docs/wutta-continuum/', None),
|
||||
}
|
||||
|
||||
|
||||
|
|
|
@ -11,13 +11,53 @@ project.
|
|||
|
||||
.. _test coverage: https://buildbot.rattailproject.org/coverage/wuttaweb/
|
||||
|
||||
However as you can see..the API should be fairly well documented but
|
||||
the narrative docs are pretty scant. That will eventually change.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: Contents:
|
||||
:maxdepth: 2
|
||||
:caption: Documentation:
|
||||
|
||||
glossary
|
||||
narr/index
|
||||
api/index
|
||||
narr/templates/index
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Package API:
|
||||
|
||||
api/wuttaweb
|
||||
api/wuttaweb.app
|
||||
api/wuttaweb.auth
|
||||
api/wuttaweb.conf
|
||||
api/wuttaweb.db
|
||||
api/wuttaweb.db.continuum
|
||||
api/wuttaweb.db.sess
|
||||
api/wuttaweb.forms
|
||||
api/wuttaweb.forms.base
|
||||
api/wuttaweb.forms.schema
|
||||
api/wuttaweb.forms.widgets
|
||||
api/wuttaweb.grids
|
||||
api/wuttaweb.grids.base
|
||||
api/wuttaweb.grids.filters
|
||||
api/wuttaweb.handler
|
||||
api/wuttaweb.helpers
|
||||
api/wuttaweb.menus
|
||||
api/wuttaweb.progress
|
||||
api/wuttaweb.static
|
||||
api/wuttaweb.subscribers
|
||||
api/wuttaweb.util
|
||||
api/wuttaweb.views
|
||||
api/wuttaweb.views.auth
|
||||
api/wuttaweb.views.base
|
||||
api/wuttaweb.views.common
|
||||
api/wuttaweb.views.essential
|
||||
api/wuttaweb.views.master
|
||||
api/wuttaweb.views.people
|
||||
api/wuttaweb.views.progress
|
||||
api/wuttaweb.views.roles
|
||||
api/wuttaweb.views.settings
|
||||
api/wuttaweb.views.upgrades
|
||||
api/wuttaweb.views.users
|
||||
|
||||
|
||||
Indices and tables
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
|
||||
Documentation
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
templates/index
|
Loading…
Add table
Add a link
Reference in a new issue