update docs config (separate modules and autosummary)

2024-04-19 03:55:59 -07:00
parent 2335001a80
commit 2c72ce80e5
51 changed files with 1580 additions and 2491 deletions
--- a/docs/_build/html/_sources/_autoref/co4.accessors.rst.txt
+++ b/docs/_build/html/_sources/_autoref/co4.accessors.rst.txt
@@ -1,34 +0,0 @@
-co4.accessors package
-=====================
-
-.. automodule:: co4.accessors
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Submodules
----------
-
-co4.accessors.fts module
------------------------
-
-.. automodule:: co4.accessors.fts
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-co4.accessors.table module
--------------------------
-
-.. automodule:: co4.accessors.table
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-co4.accessors.vss module
------------------------
-
-.. automodule:: co4.accessors.vss
-   :members:
-   :undoc-members:
-   :show-inheritance:
--- a/docs/_build/html/_sources/_autoref/co4.collectors.rst.txt
+++ b/docs/_build/html/_sources/_autoref/co4.collectors.rst.txt
@@ -1,18 +0,0 @@
-co4.collectors package
-======================
-
-.. automodule:: co4.collectors
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Submodules
----------
-
-co4.collectors.core module
--------------------------
-
-.. automodule:: co4.collectors.core
-   :members:
-   :undoc-members:
-   :show-inheritance:
--- a/docs/_build/html/_sources/_autoref/co4.composers.rst.txt
+++ b/docs/_build/html/_sources/_autoref/co4.composers.rst.txt
@@ -1,26 +0,0 @@
-co4.composers package
-=====================
-
-.. automodule:: co4.composers
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Submodules
----------
-
-co4.composers.core module
-------------------------
-
-.. automodule:: co4.composers.core
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-co4.composers.fts module
------------------------
-
-.. automodule:: co4.composers.fts
-   :members:
-   :undoc-members:
-   :show-inheritance:
--- a/docs/_build/html/_sources/_autoref/co4.databases.rst.txt
+++ b/docs/_build/html/_sources/_autoref/co4.databases.rst.txt
@@ -1,34 +0,0 @@
-co4.databases package
-=====================
-
-.. automodule:: co4.databases
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Submodules
----------
-
-co4.databases.core module
-------------------------
-
-.. automodule:: co4.databases.core
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-co4.databases.fts module
------------------------
-
-.. automodule:: co4.databases.fts
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-co4.databases.vss module
------------------------
-
-.. automodule:: co4.databases.vss
-   :members:
-   :undoc-members:
-   :show-inheritance:
--- a/docs/_build/html/_sources/_autoref/co4.managers.rst.txt
+++ b/docs/_build/html/_sources/_autoref/co4.managers.rst.txt
@@ -1,34 +0,0 @@
-co4.managers package
-====================
-
-.. automodule:: co4.managers
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Submodules
----------
-
-co4.managers.core module
------------------------
-
-.. automodule:: co4.managers.core
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-co4.managers.fts module
-----------------------
-
-.. automodule:: co4.managers.fts
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-co4.managers.vss module
-----------------------
-
-.. automodule:: co4.managers.vss
-   :members:
-   :undoc-members:
-   :show-inheritance:
--- a/docs/_build/html/_sources/_autoref/co4.rst.txt
+++ b/docs/_build/html/_sources/_autoref/co4.rst.txt
@@ -1,70 +0,0 @@
-co4 package
-===========
-
-.. automodule:: co4
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Subpackages
-----------
-
-.. toctree::
-   :maxdepth: 4
-
-   co4.accessors
-   co4.collectors
-   co4.composers
-   co4.databases
-   co4.managers
-
-Submodules
----------
-
-co4.accessor module
-------------------
-
-.. automodule:: co4.accessor
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-co4.co4 module
--------------
-
-.. automodule:: co4.co4
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-co4.collector module
--------------------
-
-.. automodule:: co4.collector
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-co4.composer module
-------------------
-
-.. automodule:: co4.composer
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-co4.indexer module
------------------
-
-.. automodule:: co4.indexer
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-co4.manager module
------------------
-
-.. automodule:: co4.manager
-   :members:
-   :undoc-members:
-   :show-inheritance:
--- a/docs/_build/html/_sources/_autoref/modules.rst.txt
+++ b/docs/_build/html/_sources/_autoref/modules.rst.txt
@@ -1,7 +1,7 @@
-co4
+co3
 ===

 .. toctree::
   :maxdepth: 4

-   co4
+   co3
--- a/docs/_build/html/_sources/index.md.txt
+++ b/docs/_build/html/_sources/index.md.txt
@@ -1,24 +1,41 @@
-# `co4` package docs 
+# `co3` package docs 
 {ref}`genindex`
 {ref}`modindex`
 {ref}`search`

+```{eval-rst}
+.. autosummary::
+   :nosignatures:
+
+    co3.Accessor
+    co3.Collector
+    co3.CO3
+    co3.Database
+    co3.Indexer
+    co3.Manager
+    co3.Mapper
+    co3.Component
+    co3.Schema
+    co3.Engine
+```
+
 ```{toctree}
 :maxdepth: 3
 :caption: Autoref

-_autoref/co4.rst
+_autoref/co3.rst
 ```

 ```{toctree}
 :maxdepth: 3
 :caption: Contents

+reference/test
+
 reference/documentation/index
 reference/site/index
 ```

-```{include} ../../README.md
+```{include} ../README.md
 ```

-