improve auto doc

2025-10-11 11:00:50 +02:00 · 2025-10-11 11:00:50 +02:00 · 72b759504b
commit 72b759504b
parent 2719f71b06
38 changed files with 115 additions and 37 deletions
--- a/docs/generated/suou.asgi.rst
+++ b/docs/generated/suou.asgi.rst
@ -1,4 +1,4 @@
-suou.asgi
+suou.asgi
 =========

 .. automodule:: suou.asgi
--- a/docs/generated/suou.bits.rst
+++ b/docs/generated/suou.bits.rst
@ -1,4 +1,4 @@
-suou.bits
+suou.bits
 =========

 .. automodule:: suou.bits
--- a/docs/generated/suou.calendar.rst
+++ b/docs/generated/suou.calendar.rst
@ -1,4 +1,4 @@
-suou.calendar
+suou.calendar
 =============

 .. automodule:: suou.calendar
--- a/docs/generated/suou.classtools.rst
+++ b/docs/generated/suou.classtools.rst
@ -1,4 +1,4 @@
-suou.classtools
+suou.classtools
 ===============

 .. automodule:: suou.classtools
--- a/docs/generated/suou.codecs.rst
+++ b/docs/generated/suou.codecs.rst
@ -1,4 +1,4 @@
-suou.codecs
+suou.codecs
 ===========

 .. automodule:: suou.codecs
--- a/docs/generated/suou.collections.rst
+++ b/docs/generated/suou.collections.rst
@ -1,4 +1,4 @@
-suou.collections
+suou.collections
 ================

 .. automodule:: suou.collections
--- a/docs/generated/suou.color.rst
+++ b/docs/generated/suou.color.rst
@ -1,4 +1,4 @@
-suou.color
+suou.color
 ==========

 .. automodule:: suou.color
--- a/docs/generated/suou.configparse.rst
+++ b/docs/generated/suou.configparse.rst
@ -1,4 +1,4 @@
-suou.configparse
+suou.configparse
 ================

 .. automodule:: suou.configparse
--- a/docs/generated/suou.dei.rst
+++ b/docs/generated/suou.dei.rst
@ -1,4 +1,4 @@
-suou.dei
+suou.dei
 ========

 .. automodule:: suou.dei
--- a/docs/generated/suou.dorks.rst
+++ b/docs/generated/suou.dorks.rst
@ -1,4 +1,4 @@
-suou.dorks
+suou.dorks
 ==========

 .. automodule:: suou.dorks
--- a/docs/generated/suou.exceptions.rst
+++ b/docs/generated/suou.exceptions.rst
@ -1,4 +1,4 @@
-suou.exceptions
+suou.exceptions
 ===============

 .. automodule:: suou.exceptions
--- a/docs/generated/suou.flask.rst
+++ b/docs/generated/suou.flask.rst
@ -1,4 +1,4 @@
-suou.flask
+suou.flask
 ==========

 .. automodule:: suou.flask
--- a/docs/generated/suou.flask_restx.rst
+++ b/docs/generated/suou.flask_restx.rst
@ -1,4 +1,4 @@
-suou.flask\_restx
+suou.flask\_restx
 =================

 .. automodule:: suou.flask_restx
--- a/docs/generated/suou.flask_sqlalchemy.rst
+++ b/docs/generated/suou.flask_sqlalchemy.rst
@ -1,4 +1,4 @@
-suou.flask\_sqlalchemy
+suou.flask\_sqlalchemy
 ======================

 .. automodule:: suou.flask_sqlalchemy
--- a/docs/generated/suou.functools.rst
+++ b/docs/generated/suou.functools.rst
@ -1,4 +1,4 @@
-suou.functools
+suou.functools
 ==============

 .. automodule:: suou.functools
--- a/docs/generated/suou.http.rst
+++ b/docs/generated/suou.http.rst
@ -1,4 +1,4 @@
-suou.http
+suou.http
 =========

 .. automodule:: suou.http
--- a/docs/generated/suou.i18n.rst
+++ b/docs/generated/suou.i18n.rst
@ -1,4 +1,4 @@
-suou.i18n
+suou.i18n
 =========

 .. automodule:: suou.i18n
--- a/docs/generated/suou.iding.rst
+++ b/docs/generated/suou.iding.rst
@ -1,4 +1,4 @@
-suou.iding
+suou.iding
 ==========

 .. automodule:: suou.iding
--- a/docs/generated/suou.itertools.rst
+++ b/docs/generated/suou.itertools.rst
@ -1,4 +1,4 @@
-suou.itertools
+suou.itertools
 ==============

 .. automodule:: suou.itertools
--- a/docs/generated/suou.legal.rst
+++ b/docs/generated/suou.legal.rst
@ -1,4 +1,4 @@
-suou.legal
+suou.legal
 ==========

 .. automodule:: suou.legal
--- a/docs/generated/suou.lex.rst
+++ b/docs/generated/suou.lex.rst
@ -1,4 +1,4 @@
-suou.lex
+suou.lex
 ========

 .. currentmodule:: suou
--- a/docs/generated/suou.luck.rst
+++ b/docs/generated/suou.luck.rst
@ -1,4 +1,4 @@
-suou.luck
+suou.luck
 =========

 .. automodule:: suou.luck
--- a/docs/generated/suou.markdown.rst
+++ b/docs/generated/suou.markdown.rst
@ -1,4 +1,4 @@
-suou.markdown
+suou.markdown
 =============

 .. automodule:: suou.markdown
--- a/docs/generated/suou.migrate.rst
+++ b/docs/generated/suou.migrate.rst
@ -1,4 +1,4 @@
-suou.migrate
+suou.migrate
 ============

 .. automodule:: suou.migrate
--- a/docs/generated/suou.quart.rst
+++ b/docs/generated/suou.quart.rst
@ -1,4 +1,4 @@
-suou.quart
+suou.quart
 ==========

 .. automodule:: suou.quart
--- a/docs/generated/suou.redact.rst
+++ b/docs/generated/suou.redact.rst
@ -1,4 +1,4 @@
-suou.redact
+suou.redact
 ===========

 .. automodule:: suou.redact
--- a/docs/generated/suou.sass.rst
+++ b/docs/generated/suou.sass.rst
@ -1,4 +1,4 @@
-suou.sass
+suou.sass
 =========

 .. automodule:: suou.sass
--- a/docs/generated/suou.signing.rst
+++ b/docs/generated/suou.signing.rst
@ -1,4 +1,4 @@
-suou.signing
+suou.signing
 ============

 .. automodule:: suou.signing
--- a/docs/generated/suou.snowflake.rst
+++ b/docs/generated/suou.snowflake.rst
@ -1,4 +1,4 @@
-suou.snowflake
+suou.snowflake
 ==============

 .. automodule:: suou.snowflake
--- a/docs/generated/suou.sqlalchemy.asyncio.rst
+++ b/docs/generated/suou.sqlalchemy.asyncio.rst
@ -0,0 +1,20 @@
+suou.sqlalchemy.asyncio
+=======================
+
+.. automodule:: suou.sqlalchemy.asyncio
+
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      async_query
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      AsyncSelectPagination
+      SQLAlchemy
+      SessionWrapper
+   
--- a/docs/generated/suou.sqlalchemy.orm.rst
+++ b/docs/generated/suou.sqlalchemy.orm.rst
@ -0,0 +1,32 @@
+suou.sqlalchemy.orm
+===================
+
+.. automodule:: suou.sqlalchemy.orm
+
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      a_relationship
+      age_pair
+      author_pair
+      bool_column
+      bound_fk
+      declarative_base
+      entity_base
+      id_column
+      match_column
+      match_constraint
+      parent_children
+      secret_column
+      snowflake_column
+      unbound_fk
+      want_column
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      BitSelector
+   
--- a/docs/generated/suou.sqlalchemy.rst
+++ b/docs/generated/suou.sqlalchemy.rst
@ -1,9 +1,15 @@
-suou.sqlalchemy
+suou.sqlalchemy
 ===============

 .. automodule:: suou.sqlalchemy

   
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+   
+      IdType
+   
   .. rubric:: Functions

   .. autosummary::
@ -17,4 +23,12 @@
   .. autosummary::
   
      AuthSrc
-   
+   
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   asyncio
+   orm
--- a/docs/generated/suou.strtools.rst
+++ b/docs/generated/suou.strtools.rst
@ -1,4 +1,4 @@
-suou.strtools
+suou.strtools
 =============

 .. automodule:: suou.strtools
--- a/docs/generated/suou.terminal.rst
+++ b/docs/generated/suou.terminal.rst
@ -1,4 +1,4 @@
-suou.terminal
+suou.terminal
 =============

 .. automodule:: suou.terminal
--- a/docs/generated/suou.validators.rst
+++ b/docs/generated/suou.validators.rst
@ -1,4 +1,4 @@
-suou.validators
+suou.validators
 ===============

 .. automodule:: suou.validators
--- a/docs/generated/suou.waiter.rst
+++ b/docs/generated/suou.waiter.rst
@ -1,4 +1,4 @@
-suou.waiter
+suou.waiter
 ===========

 .. automodule:: suou.waiter