docs/api/index.rst

@@ -0,0 +1,12 @@
+
+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

docs/api/wuttjamaican/index.rst

@@ -0,0 +1,33 @@
+
+``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

docs/index.rst

@@ -30,54 +30,24 @@ Features
 
 See also these projects which build on WuttJamaican:
 
-* `WuttaWeb <https://rattailproject.org/docs/wuttaweb/>`_ - web app
+* :doc:`wutta-continuum:index`
-  framework
+* `WuttaWeb <https://rattailproject.org/docs/wuttaweb/>`_
-* `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: 2
+   :maxdepth: 3
-   :caption: Documentation
 
    glossary
-   narr/install/index
+   narr/index
-   narr/config/index
+   api/index
-   narr/cli/index
-   narr/handlers/index
-   narr/providers/index
-   narr/db/index
 
-.. toctree::
-   :maxdepth: 1
-   :caption: API
 
-   api/wuttjamaican.app
+Indices and tables
-   api/wuttjamaican.auth
+==================
-   api/wuttjamaican.cli
+
-   api/wuttjamaican.cli.base
+* :ref:`genindex`
-   api/wuttjamaican.cli.make_uuid
+* :ref:`modindex`
-   api/wuttjamaican.conf
+* :ref:`search`
-   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

docs/narr/index.rst

@@ -0,0 +1,13 @@
+
+Documentation
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   install/index
+   config/index
+   cli/index
+   handlers/index
+   providers/index
+   db/index

src/wuttjamaican/db/model/__init__.py

@@ -25,14 +25,9 @@ Data Models
 
 This is the default :term:`app model` module.
 
-This namespace exposes the following:
+The ``wuttjamaican.db.model`` namespace contains the following:
 
 * :class:`~wuttjamaican.db.model.base.Base`
-* :func:`~wuttjamaican.db.util.uuid_column()`
-* :func:`~wuttjamaican.db.util.uuid_fk_column()`
-
-And the :term:`data models <data model>`:
-
 * :class:`~wuttjamaican.db.model.base.Setting`
 * :class:`~wuttjamaican.db.model.base.Person`
 * :class:`~wuttjamaican.db.model.auth.Role`
@@ -42,6 +37,7 @@ And the :term:`data models <data model>`:
 * :class:`~wuttjamaican.db.model.upgrades.Upgrade`
 """
 
+# TODO: remove these
 from wuttjamaican.db.util import uuid_column, uuid_fk_column
 
 from .base import Base, Setting, Person