improve auto doc

docs/api.rst

@@ -3,6 +3,7 @@ API
 
 .. autosummary::
    :toctree: generated
+   :recursive:
    
    suou.sqlalchemy
    suou.asgi
@@ -39,3 +40,4 @@ API
    suou.terminal
    suou.validators
    suou.waiter
+

docs/conf.py

@@ -41,3 +41,13 @@ autodoc_mock_imports = [
 html_theme = 'sphinx_rtd_theme'
 html_theme_path = ["_themes", ]
 html_static_path = ['_static']
+
+def polish_module_docstring(app, what, name, obj, options, lines):
+    if what == "module" and 'members' in options:
+        try:
+            del lines[lines.index('---'):]
+        except Exception:
+            pass
+
+def setup(app):
+    app.connect("autodoc-process-docstring", polish_module_docstring)

docs/generated/suou.asgi.rst

@@ -1,4 +1,4 @@
-suou.asgi
+suou.asgi
 =========
 
 .. automodule:: suou.asgi

docs/generated/suou.bits.rst

@@ -1,4 +1,4 @@
-suou.bits
+suou.bits
 =========
 
 .. automodule:: suou.bits

docs/generated/suou.calendar.rst

@@ -1,4 +1,4 @@
-suou.calendar
+suou.calendar
 =============
 
 .. automodule:: suou.calendar

docs/generated/suou.classtools.rst

@@ -1,4 +1,4 @@
-suou.classtools
+suou.classtools
 ===============
 
 .. automodule:: suou.classtools

docs/generated/suou.codecs.rst

@@ -1,4 +1,4 @@
-suou.codecs
+suou.codecs
 ===========
 
 .. automodule:: suou.codecs

docs/generated/suou.collections.rst

@@ -1,4 +1,4 @@
-suou.collections
+suou.collections
 ================
 
 .. automodule:: suou.collections

docs/generated/suou.color.rst

@@ -1,4 +1,4 @@
-suou.color
+suou.color
 ==========
 
 .. automodule:: suou.color

docs/generated/suou.configparse.rst

@@ -1,4 +1,4 @@
-suou.configparse
+suou.configparse
 ================
 
 .. automodule:: suou.configparse

docs/generated/suou.dei.rst

@@ -1,4 +1,4 @@
-suou.dei
+suou.dei
 ========
 
 .. automodule:: suou.dei

docs/generated/suou.dorks.rst

@@ -1,4 +1,4 @@
-suou.dorks
+suou.dorks
 ==========
 
 .. automodule:: suou.dorks

docs/generated/suou.exceptions.rst

@@ -1,4 +1,4 @@
-suou.exceptions
+suou.exceptions
 ===============
 
 .. automodule:: suou.exceptions

docs/generated/suou.flask.rst

@@ -1,4 +1,4 @@
-suou.flask
+suou.flask
 ==========
 
 .. automodule:: suou.flask

docs/generated/suou.flask_restx.rst

@@ -1,4 +1,4 @@
-suou.flask\_restx
+suou.flask\_restx
 =================
 
 .. automodule:: suou.flask_restx

docs/generated/suou.flask_sqlalchemy.rst

@@ -1,4 +1,4 @@
-suou.flask\_sqlalchemy
+suou.flask\_sqlalchemy
 ======================
 
 .. automodule:: suou.flask_sqlalchemy

docs/generated/suou.functools.rst

@@ -1,4 +1,4 @@
-suou.functools
+suou.functools
 ==============
 
 .. automodule:: suou.functools

docs/generated/suou.http.rst

@@ -1,4 +1,4 @@
-suou.http
+suou.http
 =========
 
 .. automodule:: suou.http

docs/generated/suou.i18n.rst

@@ -1,4 +1,4 @@
-suou.i18n
+suou.i18n
 =========
 
 .. automodule:: suou.i18n

docs/generated/suou.iding.rst

@@ -1,4 +1,4 @@
-suou.iding
+suou.iding
 ==========
 
 .. automodule:: suou.iding

docs/generated/suou.itertools.rst

@@ -1,4 +1,4 @@
-suou.itertools
+suou.itertools
 ==============
 
 .. automodule:: suou.itertools

docs/generated/suou.legal.rst

@@ -1,4 +1,4 @@
-suou.legal
+suou.legal
 ==========
 
 .. automodule:: suou.legal

docs/generated/suou.lex.rst

@@ -1,4 +1,4 @@
-suou.lex
+suou.lex
 ========
 
 .. currentmodule:: suou

docs/generated/suou.luck.rst

@@ -1,4 +1,4 @@
-suou.luck
+suou.luck
 =========
 
 .. automodule:: suou.luck

docs/generated/suou.markdown.rst

@@ -1,4 +1,4 @@
-suou.markdown
+suou.markdown
 =============
 
 .. automodule:: suou.markdown

docs/generated/suou.migrate.rst

@@ -1,4 +1,4 @@
-suou.migrate
+suou.migrate
 ============
 
 .. automodule:: suou.migrate

docs/generated/suou.quart.rst

@@ -1,4 +1,4 @@
-suou.quart
+suou.quart
 ==========
 
 .. automodule:: suou.quart

docs/generated/suou.redact.rst

@@ -1,4 +1,4 @@
-suou.redact
+suou.redact
 ===========
 
 .. automodule:: suou.redact

docs/generated/suou.sass.rst

@@ -1,4 +1,4 @@
-suou.sass
+suou.sass
 =========
 
 .. automodule:: suou.sass

docs/generated/suou.signing.rst

@@ -1,4 +1,4 @@
-suou.signing
+suou.signing
 ============
 
 .. automodule:: suou.signing

docs/generated/suou.snowflake.rst

@@ -1,4 +1,4 @@
-suou.snowflake
+suou.snowflake
 ==============
 
 .. automodule:: suou.snowflake

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
+   

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
+   

docs/generated/suou.sqlalchemy.rst

@@ -1,9 +1,15 @@
-suou.sqlalchemy
+suou.sqlalchemy
 ===============
 
 .. automodule:: suou.sqlalchemy
 
    
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+   
+      IdType
+   
    .. rubric:: Functions
 
    .. autosummary::
@@ -18,3 +24,11 @@
    
       AuthSrc
    
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   asyncio
+   orm

docs/generated/suou.strtools.rst

@@ -1,4 +1,4 @@
-suou.strtools
+suou.strtools
 =============
 
 .. automodule:: suou.strtools

docs/generated/suou.terminal.rst

@@ -1,4 +1,4 @@
-suou.terminal
+suou.terminal
 =============
 
 .. automodule:: suou.terminal

docs/generated/suou.validators.rst

@@ -1,4 +1,4 @@
-suou.validators
+suou.validators
 ===============
 
 .. automodule:: suou.validators

docs/generated/suou.waiter.rst

@@ -1,4 +1,4 @@
-suou.waiter
+suou.waiter
 ===========
 
 .. automodule:: suou.waiter