From c25325f7d09b1143fd4cdd2023d2f5eb9200e5a8 Mon Sep 17 00:00:00 2001
From: Lance Edgar <lance@wuttaproject.org>
Date: Sat, 7 Dec 2024 19:05:22 -0600
Subject: [PATCH] docs: rearrange API docs per conventions used elsewhere

e.g. in WuttaSync..this convention is better i think..?
---
 docs/api/index.rst                            | 12 -----
 .../app.rst => wuttjamaican.app.rst}          |  0
 .../auth.rst => wuttjamaican.auth.rst}        |  0
 ...cli.base.rst => wuttjamaican.cli.base.rst} |  0
 ...uid.rst => wuttjamaican.cli.make_uuid.rst} |  0
 .../cli.rst => wuttjamaican.cli.rst}          |  0
 .../conf.rst => wuttjamaican.conf.rst}        |  0
 .../db.conf.rst => wuttjamaican.db.conf.rst}  |  0
 ...uth.rst => wuttjamaican.db.model.auth.rst} |  0
 ...ase.rst => wuttjamaican.db.model.base.rst} |  0
 ...db.model.rst => wuttjamaican.db.model.rst} |  0
 ...rst => wuttjamaican.db.model.upgrades.rst} |  0
 .../db.rst => wuttjamaican.db.rst}            |  0
 .../db.sess.rst => wuttjamaican.db.sess.rst}  |  0
 .../db.util.rst => wuttjamaican.db.util.rst}  |  0
 ...ler.rst => wuttjamaican.email.handler.rst} |  0
 ...age.rst => wuttjamaican.email.message.rst} |  0
 .../email.rst => wuttjamaican.email.rst}      |  0
 .../enum.rst => wuttjamaican.enum.rst}        |  0
 .../exc.rst => wuttjamaican.exc.rst}          |  0
 .../install.rst => wuttjamaican.install.rst}  |  0
 .../people.rst => wuttjamaican.people.rst}    |  0
 ...progress.rst => wuttjamaican.progress.rst} |  0
 .../testing.rst => wuttjamaican.testing.rst}  |  0
 .../util.rst => wuttjamaican.util.rst}        |  0
 docs/api/wuttjamaican/index.rst               | 33 ------------
 docs/index.rst                                | 52 +++++++++++++++----
 docs/narr/index.rst                           | 13 -----
 28 files changed, 41 insertions(+), 69 deletions(-)
 delete mode 100644 docs/api/index.rst
 rename docs/api/{wuttjamaican/app.rst => wuttjamaican.app.rst} (100%)
 rename docs/api/{wuttjamaican/auth.rst => wuttjamaican.auth.rst} (100%)
 rename docs/api/{wuttjamaican/cli.base.rst => wuttjamaican.cli.base.rst} (100%)
 rename docs/api/{wuttjamaican/cli.make_uuid.rst => wuttjamaican.cli.make_uuid.rst} (100%)
 rename docs/api/{wuttjamaican/cli.rst => wuttjamaican.cli.rst} (100%)
 rename docs/api/{wuttjamaican/conf.rst => wuttjamaican.conf.rst} (100%)
 rename docs/api/{wuttjamaican/db.conf.rst => wuttjamaican.db.conf.rst} (100%)
 rename docs/api/{wuttjamaican/db.model.auth.rst => wuttjamaican.db.model.auth.rst} (100%)
 rename docs/api/{wuttjamaican/db.model.base.rst => wuttjamaican.db.model.base.rst} (100%)
 rename docs/api/{wuttjamaican/db.model.rst => wuttjamaican.db.model.rst} (100%)
 rename docs/api/{wuttjamaican/db.model.upgrades.rst => wuttjamaican.db.model.upgrades.rst} (100%)
 rename docs/api/{wuttjamaican/db.rst => wuttjamaican.db.rst} (100%)
 rename docs/api/{wuttjamaican/db.sess.rst => wuttjamaican.db.sess.rst} (100%)
 rename docs/api/{wuttjamaican/db.util.rst => wuttjamaican.db.util.rst} (100%)
 rename docs/api/{wuttjamaican/email.handler.rst => wuttjamaican.email.handler.rst} (100%)
 rename docs/api/{wuttjamaican/email.message.rst => wuttjamaican.email.message.rst} (100%)
 rename docs/api/{wuttjamaican/email.rst => wuttjamaican.email.rst} (100%)
 rename docs/api/{wuttjamaican/enum.rst => wuttjamaican.enum.rst} (100%)
 rename docs/api/{wuttjamaican/exc.rst => wuttjamaican.exc.rst} (100%)
 rename docs/api/{wuttjamaican/install.rst => wuttjamaican.install.rst} (100%)
 rename docs/api/{wuttjamaican/people.rst => wuttjamaican.people.rst} (100%)
 rename docs/api/{wuttjamaican/progress.rst => wuttjamaican.progress.rst} (100%)
 rename docs/api/{wuttjamaican/testing.rst => wuttjamaican.testing.rst} (100%)
 rename docs/api/{wuttjamaican/util.rst => wuttjamaican.util.rst} (100%)
 delete mode 100644 docs/api/wuttjamaican/index.rst
 delete mode 100644 docs/narr/index.rst

diff --git a/docs/api/index.rst b/docs/api/index.rst
deleted file mode 100644
index 336a1f2..0000000
--- a/docs/api/index.rst
+++ /dev/null
@@ -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
diff --git a/docs/api/wuttjamaican/app.rst b/docs/api/wuttjamaican.app.rst
similarity index 100%
rename from docs/api/wuttjamaican/app.rst
rename to docs/api/wuttjamaican.app.rst
diff --git a/docs/api/wuttjamaican/auth.rst b/docs/api/wuttjamaican.auth.rst
similarity index 100%
rename from docs/api/wuttjamaican/auth.rst
rename to docs/api/wuttjamaican.auth.rst
diff --git a/docs/api/wuttjamaican/cli.base.rst b/docs/api/wuttjamaican.cli.base.rst
similarity index 100%
rename from docs/api/wuttjamaican/cli.base.rst
rename to docs/api/wuttjamaican.cli.base.rst
diff --git a/docs/api/wuttjamaican/cli.make_uuid.rst b/docs/api/wuttjamaican.cli.make_uuid.rst
similarity index 100%
rename from docs/api/wuttjamaican/cli.make_uuid.rst
rename to docs/api/wuttjamaican.cli.make_uuid.rst
diff --git a/docs/api/wuttjamaican/cli.rst b/docs/api/wuttjamaican.cli.rst
similarity index 100%
rename from docs/api/wuttjamaican/cli.rst
rename to docs/api/wuttjamaican.cli.rst
diff --git a/docs/api/wuttjamaican/conf.rst b/docs/api/wuttjamaican.conf.rst
similarity index 100%
rename from docs/api/wuttjamaican/conf.rst
rename to docs/api/wuttjamaican.conf.rst
diff --git a/docs/api/wuttjamaican/db.conf.rst b/docs/api/wuttjamaican.db.conf.rst
similarity index 100%
rename from docs/api/wuttjamaican/db.conf.rst
rename to docs/api/wuttjamaican.db.conf.rst
diff --git a/docs/api/wuttjamaican/db.model.auth.rst b/docs/api/wuttjamaican.db.model.auth.rst
similarity index 100%
rename from docs/api/wuttjamaican/db.model.auth.rst
rename to docs/api/wuttjamaican.db.model.auth.rst
diff --git a/docs/api/wuttjamaican/db.model.base.rst b/docs/api/wuttjamaican.db.model.base.rst
similarity index 100%
rename from docs/api/wuttjamaican/db.model.base.rst
rename to docs/api/wuttjamaican.db.model.base.rst
diff --git a/docs/api/wuttjamaican/db.model.rst b/docs/api/wuttjamaican.db.model.rst
similarity index 100%
rename from docs/api/wuttjamaican/db.model.rst
rename to docs/api/wuttjamaican.db.model.rst
diff --git a/docs/api/wuttjamaican/db.model.upgrades.rst b/docs/api/wuttjamaican.db.model.upgrades.rst
similarity index 100%
rename from docs/api/wuttjamaican/db.model.upgrades.rst
rename to docs/api/wuttjamaican.db.model.upgrades.rst
diff --git a/docs/api/wuttjamaican/db.rst b/docs/api/wuttjamaican.db.rst
similarity index 100%
rename from docs/api/wuttjamaican/db.rst
rename to docs/api/wuttjamaican.db.rst
diff --git a/docs/api/wuttjamaican/db.sess.rst b/docs/api/wuttjamaican.db.sess.rst
similarity index 100%
rename from docs/api/wuttjamaican/db.sess.rst
rename to docs/api/wuttjamaican.db.sess.rst
diff --git a/docs/api/wuttjamaican/db.util.rst b/docs/api/wuttjamaican.db.util.rst
similarity index 100%
rename from docs/api/wuttjamaican/db.util.rst
rename to docs/api/wuttjamaican.db.util.rst
diff --git a/docs/api/wuttjamaican/email.handler.rst b/docs/api/wuttjamaican.email.handler.rst
similarity index 100%
rename from docs/api/wuttjamaican/email.handler.rst
rename to docs/api/wuttjamaican.email.handler.rst
diff --git a/docs/api/wuttjamaican/email.message.rst b/docs/api/wuttjamaican.email.message.rst
similarity index 100%
rename from docs/api/wuttjamaican/email.message.rst
rename to docs/api/wuttjamaican.email.message.rst
diff --git a/docs/api/wuttjamaican/email.rst b/docs/api/wuttjamaican.email.rst
similarity index 100%
rename from docs/api/wuttjamaican/email.rst
rename to docs/api/wuttjamaican.email.rst
diff --git a/docs/api/wuttjamaican/enum.rst b/docs/api/wuttjamaican.enum.rst
similarity index 100%
rename from docs/api/wuttjamaican/enum.rst
rename to docs/api/wuttjamaican.enum.rst
diff --git a/docs/api/wuttjamaican/exc.rst b/docs/api/wuttjamaican.exc.rst
similarity index 100%
rename from docs/api/wuttjamaican/exc.rst
rename to docs/api/wuttjamaican.exc.rst
diff --git a/docs/api/wuttjamaican/install.rst b/docs/api/wuttjamaican.install.rst
similarity index 100%
rename from docs/api/wuttjamaican/install.rst
rename to docs/api/wuttjamaican.install.rst
diff --git a/docs/api/wuttjamaican/people.rst b/docs/api/wuttjamaican.people.rst
similarity index 100%
rename from docs/api/wuttjamaican/people.rst
rename to docs/api/wuttjamaican.people.rst
diff --git a/docs/api/wuttjamaican/progress.rst b/docs/api/wuttjamaican.progress.rst
similarity index 100%
rename from docs/api/wuttjamaican/progress.rst
rename to docs/api/wuttjamaican.progress.rst
diff --git a/docs/api/wuttjamaican/testing.rst b/docs/api/wuttjamaican.testing.rst
similarity index 100%
rename from docs/api/wuttjamaican/testing.rst
rename to docs/api/wuttjamaican.testing.rst
diff --git a/docs/api/wuttjamaican/util.rst b/docs/api/wuttjamaican.util.rst
similarity index 100%
rename from docs/api/wuttjamaican/util.rst
rename to docs/api/wuttjamaican.util.rst
diff --git a/docs/api/wuttjamaican/index.rst b/docs/api/wuttjamaican/index.rst
deleted file mode 100644
index 1f8456b..0000000
--- a/docs/api/wuttjamaican/index.rst
+++ /dev/null
@@ -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
diff --git a/docs/index.rst b/docs/index.rst
index 1e9e36b..78f11aa 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -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
diff --git a/docs/narr/index.rst b/docs/narr/index.rst
deleted file mode 100644
index 47624eb..0000000
--- a/docs/narr/index.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-
-Documentation
-=============
-
-.. toctree::
-   :maxdepth: 2
-
-   install/index
-   config/index
-   cli/index
-   handlers/index
-   providers/index
-   db/index