From 72b759504b7d637594fe0de9b9e7af13fc6b2c47 Mon Sep 17 00:00:00 2001 From: Yusur Princeps Date: Sat, 11 Oct 2025 11:00:50 +0200 Subject: [PATCH] improve auto doc --- docs/api.rst | 6 ++-- docs/conf.py | 10 +++++++ docs/generated/suou.asgi.rst | 2 +- docs/generated/suou.bits.rst | 2 +- docs/generated/suou.calendar.rst | 2 +- docs/generated/suou.classtools.rst | 2 +- docs/generated/suou.codecs.rst | 2 +- docs/generated/suou.collections.rst | 2 +- docs/generated/suou.color.rst | 2 +- docs/generated/suou.configparse.rst | 2 +- docs/generated/suou.dei.rst | 2 +- docs/generated/suou.dorks.rst | 2 +- docs/generated/suou.exceptions.rst | 2 +- docs/generated/suou.flask.rst | 2 +- docs/generated/suou.flask_restx.rst | 2 +- docs/generated/suou.flask_sqlalchemy.rst | 2 +- docs/generated/suou.functools.rst | 2 +- docs/generated/suou.http.rst | 2 +- docs/generated/suou.i18n.rst | 2 +- docs/generated/suou.iding.rst | 2 +- docs/generated/suou.itertools.rst | 2 +- docs/generated/suou.legal.rst | 2 +- docs/generated/suou.lex.rst | 2 +- docs/generated/suou.luck.rst | 2 +- docs/generated/suou.markdown.rst | 2 +- docs/generated/suou.migrate.rst | 2 +- docs/generated/suou.quart.rst | 2 +- docs/generated/suou.redact.rst | 2 +- docs/generated/suou.sass.rst | 2 +- docs/generated/suou.signing.rst | 2 +- docs/generated/suou.snowflake.rst | 2 +- docs/generated/suou.sqlalchemy.asyncio.rst | 20 ++++++++++++++ docs/generated/suou.sqlalchemy.orm.rst | 32 ++++++++++++++++++++++ docs/generated/suou.sqlalchemy.rst | 18 ++++++++++-- docs/generated/suou.strtools.rst | 2 +- docs/generated/suou.terminal.rst | 2 +- docs/generated/suou.validators.rst | 2 +- docs/generated/suou.waiter.rst | 2 +- 38 files changed, 115 insertions(+), 37 deletions(-) create mode 100644 docs/generated/suou.sqlalchemy.asyncio.rst create mode 100644 docs/generated/suou.sqlalchemy.orm.rst diff --git a/docs/api.rst b/docs/api.rst index 1a515aa..72b76e8 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -3,7 +3,8 @@ API .. autosummary:: :toctree: generated - + :recursive: + suou.sqlalchemy suou.asgi suou.bits @@ -38,4 +39,5 @@ API suou.strtools suou.terminal suou.validators - suou.waiter \ No newline at end of file + suou.waiter + diff --git a/docs/conf.py b/docs/conf.py index a071892..5d415f2 100644 --- a/docs/conf.py +++ b/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) \ No newline at end of file diff --git a/docs/generated/suou.asgi.rst b/docs/generated/suou.asgi.rst index 00c5839..544a166 100644 --- a/docs/generated/suou.asgi.rst +++ b/docs/generated/suou.asgi.rst @@ -1,4 +1,4 @@ -suou.asgi +suou.asgi ========= .. automodule:: suou.asgi diff --git a/docs/generated/suou.bits.rst b/docs/generated/suou.bits.rst index d8b4a3e..7c1be4d 100644 --- a/docs/generated/suou.bits.rst +++ b/docs/generated/suou.bits.rst @@ -1,4 +1,4 @@ -suou.bits +suou.bits ========= .. automodule:: suou.bits diff --git a/docs/generated/suou.calendar.rst b/docs/generated/suou.calendar.rst index 510743d..ba4d0b5 100644 --- a/docs/generated/suou.calendar.rst +++ b/docs/generated/suou.calendar.rst @@ -1,4 +1,4 @@ -suou.calendar +suou.calendar ============= .. automodule:: suou.calendar diff --git a/docs/generated/suou.classtools.rst b/docs/generated/suou.classtools.rst index db0a16a..2e87377 100644 --- a/docs/generated/suou.classtools.rst +++ b/docs/generated/suou.classtools.rst @@ -1,4 +1,4 @@ -suou.classtools +suou.classtools =============== .. automodule:: suou.classtools diff --git a/docs/generated/suou.codecs.rst b/docs/generated/suou.codecs.rst index bfd0260..0112a23 100644 --- a/docs/generated/suou.codecs.rst +++ b/docs/generated/suou.codecs.rst @@ -1,4 +1,4 @@ -suou.codecs +suou.codecs =========== .. automodule:: suou.codecs diff --git a/docs/generated/suou.collections.rst b/docs/generated/suou.collections.rst index 57899fd..6382120 100644 --- a/docs/generated/suou.collections.rst +++ b/docs/generated/suou.collections.rst @@ -1,4 +1,4 @@ -suou.collections +suou.collections ================ .. automodule:: suou.collections diff --git a/docs/generated/suou.color.rst b/docs/generated/suou.color.rst index b87aaa4..03365c4 100644 --- a/docs/generated/suou.color.rst +++ b/docs/generated/suou.color.rst @@ -1,4 +1,4 @@ -suou.color +suou.color ========== .. automodule:: suou.color diff --git a/docs/generated/suou.configparse.rst b/docs/generated/suou.configparse.rst index ea6c6ad..5bdf99c 100644 --- a/docs/generated/suou.configparse.rst +++ b/docs/generated/suou.configparse.rst @@ -1,4 +1,4 @@ -suou.configparse +suou.configparse ================ .. automodule:: suou.configparse diff --git a/docs/generated/suou.dei.rst b/docs/generated/suou.dei.rst index 5604f14..9c9c870 100644 --- a/docs/generated/suou.dei.rst +++ b/docs/generated/suou.dei.rst @@ -1,4 +1,4 @@ -suou.dei +suou.dei ======== .. automodule:: suou.dei diff --git a/docs/generated/suou.dorks.rst b/docs/generated/suou.dorks.rst index ec092e7..8da809b 100644 --- a/docs/generated/suou.dorks.rst +++ b/docs/generated/suou.dorks.rst @@ -1,4 +1,4 @@ -suou.dorks +suou.dorks ========== .. automodule:: suou.dorks diff --git a/docs/generated/suou.exceptions.rst b/docs/generated/suou.exceptions.rst index 8f42c2d..056200c 100644 --- a/docs/generated/suou.exceptions.rst +++ b/docs/generated/suou.exceptions.rst @@ -1,4 +1,4 @@ -suou.exceptions +suou.exceptions =============== .. automodule:: suou.exceptions diff --git a/docs/generated/suou.flask.rst b/docs/generated/suou.flask.rst index 42193eb..6adf3f8 100644 --- a/docs/generated/suou.flask.rst +++ b/docs/generated/suou.flask.rst @@ -1,4 +1,4 @@ -suou.flask +suou.flask ========== .. automodule:: suou.flask diff --git a/docs/generated/suou.flask_restx.rst b/docs/generated/suou.flask_restx.rst index e02d399..7267c4a 100644 --- 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 diff --git a/docs/generated/suou.flask_sqlalchemy.rst b/docs/generated/suou.flask_sqlalchemy.rst index e89c0bf..458fa6f 100644 --- 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 diff --git a/docs/generated/suou.functools.rst b/docs/generated/suou.functools.rst index 6035dff..ae9e871 100644 --- a/docs/generated/suou.functools.rst +++ b/docs/generated/suou.functools.rst @@ -1,4 +1,4 @@ -suou.functools +suou.functools ============== .. automodule:: suou.functools diff --git a/docs/generated/suou.http.rst b/docs/generated/suou.http.rst index 82c9332..ac2ce02 100644 --- a/docs/generated/suou.http.rst +++ b/docs/generated/suou.http.rst @@ -1,4 +1,4 @@ -suou.http +suou.http ========= .. automodule:: suou.http diff --git a/docs/generated/suou.i18n.rst b/docs/generated/suou.i18n.rst index 7f92f78..ecc0cd7 100644 --- a/docs/generated/suou.i18n.rst +++ b/docs/generated/suou.i18n.rst @@ -1,4 +1,4 @@ -suou.i18n +suou.i18n ========= .. automodule:: suou.i18n diff --git a/docs/generated/suou.iding.rst b/docs/generated/suou.iding.rst index a47d428..a8e2f06 100644 --- a/docs/generated/suou.iding.rst +++ b/docs/generated/suou.iding.rst @@ -1,4 +1,4 @@ -suou.iding +suou.iding ========== .. automodule:: suou.iding diff --git a/docs/generated/suou.itertools.rst b/docs/generated/suou.itertools.rst index 3ee27ab..80c8f2b 100644 --- a/docs/generated/suou.itertools.rst +++ b/docs/generated/suou.itertools.rst @@ -1,4 +1,4 @@ -suou.itertools +suou.itertools ============== .. automodule:: suou.itertools diff --git a/docs/generated/suou.legal.rst b/docs/generated/suou.legal.rst index e119f97..f19f6f0 100644 --- a/docs/generated/suou.legal.rst +++ b/docs/generated/suou.legal.rst @@ -1,4 +1,4 @@ -suou.legal +suou.legal ========== .. automodule:: suou.legal diff --git a/docs/generated/suou.lex.rst b/docs/generated/suou.lex.rst index 6a49b80..83ad3a1 100644 --- a/docs/generated/suou.lex.rst +++ b/docs/generated/suou.lex.rst @@ -1,4 +1,4 @@ -suou.lex +suou.lex ======== .. currentmodule:: suou diff --git a/docs/generated/suou.luck.rst b/docs/generated/suou.luck.rst index 9480188..7dc64b3 100644 --- a/docs/generated/suou.luck.rst +++ b/docs/generated/suou.luck.rst @@ -1,4 +1,4 @@ -suou.luck +suou.luck ========= .. automodule:: suou.luck diff --git a/docs/generated/suou.markdown.rst b/docs/generated/suou.markdown.rst index 5476d20..e968de5 100644 --- a/docs/generated/suou.markdown.rst +++ b/docs/generated/suou.markdown.rst @@ -1,4 +1,4 @@ -suou.markdown +suou.markdown ============= .. automodule:: suou.markdown diff --git a/docs/generated/suou.migrate.rst b/docs/generated/suou.migrate.rst index 2b35157..9f439a9 100644 --- a/docs/generated/suou.migrate.rst +++ b/docs/generated/suou.migrate.rst @@ -1,4 +1,4 @@ -suou.migrate +suou.migrate ============ .. automodule:: suou.migrate diff --git a/docs/generated/suou.quart.rst b/docs/generated/suou.quart.rst index 9be2817..f0c93c5 100644 --- a/docs/generated/suou.quart.rst +++ b/docs/generated/suou.quart.rst @@ -1,4 +1,4 @@ -suou.quart +suou.quart ========== .. automodule:: suou.quart diff --git a/docs/generated/suou.redact.rst b/docs/generated/suou.redact.rst index b5208ec..71e8607 100644 --- a/docs/generated/suou.redact.rst +++ b/docs/generated/suou.redact.rst @@ -1,4 +1,4 @@ -suou.redact +suou.redact =========== .. automodule:: suou.redact diff --git a/docs/generated/suou.sass.rst b/docs/generated/suou.sass.rst index 6ad4426..52d6fdd 100644 --- a/docs/generated/suou.sass.rst +++ b/docs/generated/suou.sass.rst @@ -1,4 +1,4 @@ -suou.sass +suou.sass ========= .. automodule:: suou.sass diff --git a/docs/generated/suou.signing.rst b/docs/generated/suou.signing.rst index b57968d..eec63ad 100644 --- a/docs/generated/suou.signing.rst +++ b/docs/generated/suou.signing.rst @@ -1,4 +1,4 @@ -suou.signing +suou.signing ============ .. automodule:: suou.signing diff --git a/docs/generated/suou.snowflake.rst b/docs/generated/suou.snowflake.rst index fa072d3..be112da 100644 --- a/docs/generated/suou.snowflake.rst +++ b/docs/generated/suou.snowflake.rst @@ -1,4 +1,4 @@ -suou.snowflake +suou.snowflake ============== .. automodule:: suou.snowflake diff --git a/docs/generated/suou.sqlalchemy.asyncio.rst b/docs/generated/suou.sqlalchemy.asyncio.rst new file mode 100644 index 0000000..872ac14 --- /dev/null +++ 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 + \ No newline at end of file diff --git a/docs/generated/suou.sqlalchemy.orm.rst b/docs/generated/suou.sqlalchemy.orm.rst new file mode 100644 index 0000000..41cb2c0 --- /dev/null +++ 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 + \ No newline at end of file diff --git a/docs/generated/suou.sqlalchemy.rst b/docs/generated/suou.sqlalchemy.rst index 118bf3a..9a28efa 100644 --- 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 - \ No newline at end of file + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + asyncio + orm diff --git a/docs/generated/suou.strtools.rst b/docs/generated/suou.strtools.rst index c9df5c0..1bc81a1 100644 --- a/docs/generated/suou.strtools.rst +++ b/docs/generated/suou.strtools.rst @@ -1,4 +1,4 @@ -suou.strtools +suou.strtools ============= .. automodule:: suou.strtools diff --git a/docs/generated/suou.terminal.rst b/docs/generated/suou.terminal.rst index 71d531f..7655533 100644 --- a/docs/generated/suou.terminal.rst +++ b/docs/generated/suou.terminal.rst @@ -1,4 +1,4 @@ -suou.terminal +suou.terminal ============= .. automodule:: suou.terminal diff --git a/docs/generated/suou.validators.rst b/docs/generated/suou.validators.rst index 673e889..b7974a0 100644 --- a/docs/generated/suou.validators.rst +++ b/docs/generated/suou.validators.rst @@ -1,4 +1,4 @@ -suou.validators +suou.validators =============== .. automodule:: suou.validators diff --git a/docs/generated/suou.waiter.rst b/docs/generated/suou.waiter.rst index c668f25..e420b75 100644 --- a/docs/generated/suou.waiter.rst +++ b/docs/generated/suou.waiter.rst @@ -1,4 +1,4 @@ -suou.waiter +suou.waiter =========== .. automodule:: suou.waiter