docs: rearrange API docs per conventions used elsewhere
e.g. in WuttaSync..this convention is better i think..?
This commit is contained in:
parent
ed5e886a5d
commit
c25325f7d0
|
@ -1,12 +0,0 @@
|
|||
|
||||
Package API
|
||||
===========
|
||||
|
||||
This is the "raw" API documentation for the ``wuttjamaican`` package. It hopefully
|
||||
contains all pertinent info regarding available functions, classes and their
|
||||
attributes and method signatures etc.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
wuttjamaican/index
|
|
@ -1,33 +0,0 @@
|
|||
|
||||
``wuttjamaican``
|
||||
================
|
||||
|
||||
.. automodule:: wuttjamaican
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
app
|
||||
auth
|
||||
cli
|
||||
cli.base
|
||||
cli.make_uuid
|
||||
conf
|
||||
db
|
||||
db.conf
|
||||
db.model
|
||||
db.model.auth
|
||||
db.model.base
|
||||
db.model.upgrades
|
||||
db.sess
|
||||
db.util
|
||||
email
|
||||
email.handler
|
||||
email.message
|
||||
enum
|
||||
exc
|
||||
install
|
||||
people
|
||||
progress
|
||||
testing
|
||||
util
|
|
@ -30,24 +30,54 @@ Features
|
|||
|
||||
See also these projects which build on WuttJamaican:
|
||||
|
||||
* :doc:`wutta-continuum:index`
|
||||
* `WuttaWeb <https://rattailproject.org/docs/wuttaweb/>`_
|
||||
* `WuttaWeb <https://rattailproject.org/docs/wuttaweb/>`_ - web app
|
||||
framework
|
||||
* `WuttaSync <https://rattailproject.org/docs/wuttasync/>`_ - data
|
||||
import/export and real-time sync
|
||||
* :doc:`wutta-continuum:index` - data versioning with
|
||||
SQLAchemy-Continuum
|
||||
|
||||
|
||||
Contents
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:maxdepth: 2
|
||||
:caption: Documentation
|
||||
|
||||
glossary
|
||||
narr/index
|
||||
api/index
|
||||
narr/install/index
|
||||
narr/config/index
|
||||
narr/cli/index
|
||||
narr/handlers/index
|
||||
narr/providers/index
|
||||
narr/db/index
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: API
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
api/wuttjamaican.app
|
||||
api/wuttjamaican.auth
|
||||
api/wuttjamaican.cli
|
||||
api/wuttjamaican.cli.base
|
||||
api/wuttjamaican.cli.make_uuid
|
||||
api/wuttjamaican.conf
|
||||
api/wuttjamaican.db
|
||||
api/wuttjamaican.db.conf
|
||||
api/wuttjamaican.db.model
|
||||
api/wuttjamaican.db.model.auth
|
||||
api/wuttjamaican.db.model.base
|
||||
api/wuttjamaican.db.model.upgrades
|
||||
api/wuttjamaican.db.sess
|
||||
api/wuttjamaican.db.util
|
||||
api/wuttjamaican.email
|
||||
api/wuttjamaican.email.handler
|
||||
api/wuttjamaican.email.message
|
||||
api/wuttjamaican.enum
|
||||
api/wuttjamaican.exc
|
||||
api/wuttjamaican.install
|
||||
api/wuttjamaican.people
|
||||
api/wuttjamaican.progress
|
||||
api/wuttjamaican.testing
|
||||
api/wuttjamaican.util
|
||||
|
|
|
@ -1,13 +0,0 @@
|
|||
|
||||
Documentation
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
install/index
|
||||
config/index
|
||||
cli/index
|
||||
handlers/index
|
||||
providers/index
|
||||
db/index
|
Loading…
Reference in a new issue