improve auto doc
This commit is contained in:
parent
2719f71b06
commit
72b759504b
38 changed files with 115 additions and 37 deletions
|
|
@ -3,7 +3,8 @@ API
|
||||||
|
|
||||||
.. autosummary::
|
.. autosummary::
|
||||||
:toctree: generated
|
:toctree: generated
|
||||||
|
:recursive:
|
||||||
|
|
||||||
suou.sqlalchemy
|
suou.sqlalchemy
|
||||||
suou.asgi
|
suou.asgi
|
||||||
suou.bits
|
suou.bits
|
||||||
|
|
@ -38,4 +39,5 @@ API
|
||||||
suou.strtools
|
suou.strtools
|
||||||
suou.terminal
|
suou.terminal
|
||||||
suou.validators
|
suou.validators
|
||||||
suou.waiter
|
suou.waiter
|
||||||
|
|
||||||
|
|
|
||||||
10
docs/conf.py
10
docs/conf.py
|
|
@ -41,3 +41,13 @@ autodoc_mock_imports = [
|
||||||
html_theme = 'sphinx_rtd_theme'
|
html_theme = 'sphinx_rtd_theme'
|
||||||
html_theme_path = ["_themes", ]
|
html_theme_path = ["_themes", ]
|
||||||
html_static_path = ['_static']
|
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)
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.asgi
|
suou.asgi
|
||||||
=========
|
=========
|
||||||
|
|
||||||
.. automodule:: suou.asgi
|
.. automodule:: suou.asgi
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.bits
|
suou.bits
|
||||||
=========
|
=========
|
||||||
|
|
||||||
.. automodule:: suou.bits
|
.. automodule:: suou.bits
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.calendar
|
suou.calendar
|
||||||
=============
|
=============
|
||||||
|
|
||||||
.. automodule:: suou.calendar
|
.. automodule:: suou.calendar
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.classtools
|
suou.classtools
|
||||||
===============
|
===============
|
||||||
|
|
||||||
.. automodule:: suou.classtools
|
.. automodule:: suou.classtools
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.codecs
|
suou.codecs
|
||||||
===========
|
===========
|
||||||
|
|
||||||
.. automodule:: suou.codecs
|
.. automodule:: suou.codecs
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.collections
|
suou.collections
|
||||||
================
|
================
|
||||||
|
|
||||||
.. automodule:: suou.collections
|
.. automodule:: suou.collections
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.color
|
suou.color
|
||||||
==========
|
==========
|
||||||
|
|
||||||
.. automodule:: suou.color
|
.. automodule:: suou.color
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.configparse
|
suou.configparse
|
||||||
================
|
================
|
||||||
|
|
||||||
.. automodule:: suou.configparse
|
.. automodule:: suou.configparse
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.dei
|
suou.dei
|
||||||
========
|
========
|
||||||
|
|
||||||
.. automodule:: suou.dei
|
.. automodule:: suou.dei
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.dorks
|
suou.dorks
|
||||||
==========
|
==========
|
||||||
|
|
||||||
.. automodule:: suou.dorks
|
.. automodule:: suou.dorks
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.exceptions
|
suou.exceptions
|
||||||
===============
|
===============
|
||||||
|
|
||||||
.. automodule:: suou.exceptions
|
.. automodule:: suou.exceptions
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.flask
|
suou.flask
|
||||||
==========
|
==========
|
||||||
|
|
||||||
.. automodule:: suou.flask
|
.. automodule:: suou.flask
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.flask\_restx
|
suou.flask\_restx
|
||||||
=================
|
=================
|
||||||
|
|
||||||
.. automodule:: suou.flask_restx
|
.. automodule:: suou.flask_restx
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.flask\_sqlalchemy
|
suou.flask\_sqlalchemy
|
||||||
======================
|
======================
|
||||||
|
|
||||||
.. automodule:: suou.flask_sqlalchemy
|
.. automodule:: suou.flask_sqlalchemy
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.functools
|
suou.functools
|
||||||
==============
|
==============
|
||||||
|
|
||||||
.. automodule:: suou.functools
|
.. automodule:: suou.functools
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.http
|
suou.http
|
||||||
=========
|
=========
|
||||||
|
|
||||||
.. automodule:: suou.http
|
.. automodule:: suou.http
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.i18n
|
suou.i18n
|
||||||
=========
|
=========
|
||||||
|
|
||||||
.. automodule:: suou.i18n
|
.. automodule:: suou.i18n
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.iding
|
suou.iding
|
||||||
==========
|
==========
|
||||||
|
|
||||||
.. automodule:: suou.iding
|
.. automodule:: suou.iding
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.itertools
|
suou.itertools
|
||||||
==============
|
==============
|
||||||
|
|
||||||
.. automodule:: suou.itertools
|
.. automodule:: suou.itertools
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.legal
|
suou.legal
|
||||||
==========
|
==========
|
||||||
|
|
||||||
.. automodule:: suou.legal
|
.. automodule:: suou.legal
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.lex
|
suou.lex
|
||||||
========
|
========
|
||||||
|
|
||||||
.. currentmodule:: suou
|
.. currentmodule:: suou
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.luck
|
suou.luck
|
||||||
=========
|
=========
|
||||||
|
|
||||||
.. automodule:: suou.luck
|
.. automodule:: suou.luck
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.markdown
|
suou.markdown
|
||||||
=============
|
=============
|
||||||
|
|
||||||
.. automodule:: suou.markdown
|
.. automodule:: suou.markdown
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.migrate
|
suou.migrate
|
||||||
============
|
============
|
||||||
|
|
||||||
.. automodule:: suou.migrate
|
.. automodule:: suou.migrate
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.quart
|
suou.quart
|
||||||
==========
|
==========
|
||||||
|
|
||||||
.. automodule:: suou.quart
|
.. automodule:: suou.quart
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.redact
|
suou.redact
|
||||||
===========
|
===========
|
||||||
|
|
||||||
.. automodule:: suou.redact
|
.. automodule:: suou.redact
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.sass
|
suou.sass
|
||||||
=========
|
=========
|
||||||
|
|
||||||
.. automodule:: suou.sass
|
.. automodule:: suou.sass
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.signing
|
suou.signing
|
||||||
============
|
============
|
||||||
|
|
||||||
.. automodule:: suou.signing
|
.. automodule:: suou.signing
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.snowflake
|
suou.snowflake
|
||||||
==============
|
==============
|
||||||
|
|
||||||
.. automodule:: suou.snowflake
|
.. automodule:: suou.snowflake
|
||||||
|
|
|
||||||
20
docs/generated/suou.sqlalchemy.asyncio.rst
Normal file
20
docs/generated/suou.sqlalchemy.asyncio.rst
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
suou.sqlalchemy.asyncio
|
||||||
|
=======================
|
||||||
|
|
||||||
|
.. automodule:: suou.sqlalchemy.asyncio
|
||||||
|
|
||||||
|
|
||||||
|
.. rubric:: Functions
|
||||||
|
|
||||||
|
.. autosummary::
|
||||||
|
|
||||||
|
async_query
|
||||||
|
|
||||||
|
.. rubric:: Classes
|
||||||
|
|
||||||
|
.. autosummary::
|
||||||
|
|
||||||
|
AsyncSelectPagination
|
||||||
|
SQLAlchemy
|
||||||
|
SessionWrapper
|
||||||
|
|
||||||
32
docs/generated/suou.sqlalchemy.orm.rst
Normal file
32
docs/generated/suou.sqlalchemy.orm.rst
Normal file
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -1,9 +1,15 @@
|
||||||
suou.sqlalchemy
|
suou.sqlalchemy
|
||||||
===============
|
===============
|
||||||
|
|
||||||
.. automodule:: suou.sqlalchemy
|
.. automodule:: suou.sqlalchemy
|
||||||
|
|
||||||
|
|
||||||
|
.. rubric:: Module Attributes
|
||||||
|
|
||||||
|
.. autosummary::
|
||||||
|
|
||||||
|
IdType
|
||||||
|
|
||||||
.. rubric:: Functions
|
.. rubric:: Functions
|
||||||
|
|
||||||
.. autosummary::
|
.. autosummary::
|
||||||
|
|
@ -17,4 +23,12 @@
|
||||||
.. autosummary::
|
.. autosummary::
|
||||||
|
|
||||||
AuthSrc
|
AuthSrc
|
||||||
|
|
||||||
|
.. rubric:: Modules
|
||||||
|
|
||||||
|
.. autosummary::
|
||||||
|
:toctree:
|
||||||
|
:recursive:
|
||||||
|
|
||||||
|
asyncio
|
||||||
|
orm
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.strtools
|
suou.strtools
|
||||||
=============
|
=============
|
||||||
|
|
||||||
.. automodule:: suou.strtools
|
.. automodule:: suou.strtools
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.terminal
|
suou.terminal
|
||||||
=============
|
=============
|
||||||
|
|
||||||
.. automodule:: suou.terminal
|
.. automodule:: suou.terminal
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.validators
|
suou.validators
|
||||||
===============
|
===============
|
||||||
|
|
||||||
.. automodule:: suou.validators
|
.. automodule:: suou.validators
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
suou.waiter
|
suou.waiter
|
||||||
===========
|
===========
|
||||||
|
|
||||||
.. automodule:: suou.waiter
|
.. automodule:: suou.waiter
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue