Additonal annotations

This commit is contained in:
Adam Hopkins
2021-01-29 16:19:10 +02:00
parent 65b76f2762
commit b958cdc151
16 changed files with 394 additions and 119 deletions

View File

@@ -156,7 +156,12 @@ epub_exclude_files = ["search.html"]
suppress_warnings = ["image.nonlocal_uri"]
autodoc_member_order = "bysource"
autodoc_typehints = "description"
autodoc_default_options = {
"member-order": "groupwise",
}
# app setup hook
def setup(app):

View File

@@ -4,7 +4,7 @@ Guides
======
.. toctree::
:maxdepth: 3
:maxdepth: 4
sanic/api_reference

View File

@@ -31,109 +31,92 @@ sanic.compat
.. automodule:: sanic.compat
:members:
sanic.config
------------
.. automodule:: sanic.config
:members:
:undoc-members:
sanic.constants
---------------
.. automodule:: sanic.constants
:members:
:undoc-members:
sanic.cookies
-------------
.. automodule:: sanic.cookies
:members:
:undoc-members:
sanic.errorpages
----------------
.. automodule:: sanic.errorpages
:members:
sanic.exceptions
----------------
.. automodule:: sanic.exceptions
:members:
:undoc-members:
sanic.handlers
--------------
.. automodule:: sanic.handlers
:members:
:undoc-members:
sanic.http
----------
.. automodule:: sanic.http
:members:
sanic.log
---------
.. automodule:: sanic.log
:members:
:undoc-members:
sanic.request
-------------
.. automodule:: sanic.request
:members:
:undoc-members:
sanic.response
--------------
.. automodule:: sanic.response
:members:
:undoc-members:
sanic.router
------------
.. automodule:: sanic.router
:members:
:undoc-members:
sanic.server
------------
.. automodule:: sanic.server
:members:
:undoc-members:
sanic.static
------------
.. automodule:: sanic.static
:members:
:undoc-members:
sanic.views
-----------
.. automodule:: sanic.views
:members:
:undoc-members:
sanic.websocket
---------------
.. automodule:: sanic.websocket
:members:
:undoc-members:
sanic.worker
------------
.. automodule:: sanic.worker
:members:
:undoc-members:
Module contents
---------------
.. automodule:: sanic
:members:
:undoc-members: