Skip to content

Commit

Permalink
Documentation for all official extensions
Browse files Browse the repository at this point in the history
  • Loading branch information
miguelgrinberg committed Aug 6, 2022
1 parent 3bcdf4d commit 09dc3ef
Show file tree
Hide file tree
Showing 7 changed files with 331 additions and 67 deletions.
84 changes: 27 additions & 57 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,92 +4,71 @@ API Reference
``microdot`` module
-------------------

The ``microdot`` module defines a few classes that help implement HTTP-based
servers for MicroPython and standard Python, with multithreading support for
Python interpreters that support it.

``Microdot`` class
~~~~~~~~~~~~~~~~~~

.. autoclass:: microdot.Microdot
:members:

``Request`` class
~~~~~~~~~~~~~~~~~

.. autoclass:: microdot.Request
:members:

``Response`` class
~~~~~~~~~~~~~~~~~~

.. autoclass:: microdot.Response
:members:

``MultiDict`` class
~~~~~~~~~~~~~~~~~~~

.. autoclass:: microdot.MultiDict
:members:

``microdot_asyncio`` module
---------------------------

The ``microdot_asyncio`` module defines a few classes that help implement
HTTP-based servers for MicroPython and standard Python that use ``asyncio``
and coroutines.

``Microdot`` class
~~~~~~~~~~~~~~~~~~

.. autoclass:: microdot_asyncio.Microdot
:inherited-members:
:members:

``Request`` class
~~~~~~~~~~~~~~~~~

.. autoclass:: microdot_asyncio.Request
:inherited-members:
:members:

``Response`` class
~~~~~~~~~~~~~~~~~~

.. autoclass:: microdot_asyncio.Response
:inherited-members:
:members:

``microdot_test_client`` module
-------------------------------
``microdot_utemplate`` module
-----------------------------

The ``microdot_test_client`` module defines a test client that can be used to
create automated tests for the Microdot server.
.. automodule:: microdot_utemplate
:members:

``TestClient`` class
~~~~~~~~~~~~~~~~~~~~
``microdot_jinja`` module
-------------------------

.. autoclass:: microdot_test_client.TestClient
.. automodule:: microdot_jinja
:members:

``TestResponse`` class
~~~~~~~~~~~~~~~~~~~~~~
``microdot_session`` module
---------------------------

.. automodule:: microdot_session
:members:

``microdot_test_client`` module
-------------------------------

.. autoclass:: microdot_test_client.TestClient
:members:

.. autoclass:: microdot_test_client.TestResponse
:members:

``microdot_wsgi`` module
------------------------
``microdot_asyncio_test_client`` module
---------------------------------------

The ``microdot_wsgi`` module provides an extended ``Microdot`` class that
implements the WSGI protocol and can be used with a compliant WSGI web server
such as `Gunicorn <https://gunicorn.org/>`_ or
`uWSGI <https://uwsgi-docs.readthedocs.io/en/latest/>`_. Since there are
no WSGI web servers available for MicroPython, this support is currently
limited to standard Python.
.. autoclass:: microdot_asyncio_test_client.TestClient
:members:

``Microdot`` class
~~~~~~~~~~~~~~~~~~
.. autoclass:: microdot_asyncio_test_client.TestResponse
:members:

``microdot_wsgi`` module
------------------------

.. autoclass:: microdot_wsgi.Microdot
:members:
Expand All @@ -98,15 +77,6 @@ limited to standard Python.
``microdot_asgi`` module
------------------------

The ``microdot_asgi`` module provides an extended ``Microdot`` class that
implements the ASGI protocol and can be used with a compliant ASGI server such
as `Uvicorn <https://www.uvicorn.org/>`_. Since there are no ASGI web servers
available for MicroPython, this support is currently limited to standard
Python.

``Microdot`` class
~~~~~~~~~~~~~~~~~~

.. autoclass:: microdot_asgi.Microdot
:members:
:exclude-members: shutdown, run
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import os
import sys
sys.path.insert(0, os.path.abspath('../src'))

sys.path.insert(1, os.path.abspath('../libs/common'))

# -- Project information -----------------------------------------------------

Expand Down
Loading

0 comments on commit 09dc3ef

Please sign in to comment.