Documentation improvements
This commit is contained in:
42
docs/api.rst
42
docs/api.rst
@@ -1,8 +1,8 @@
|
||||
API Reference
|
||||
=============
|
||||
|
||||
``microdot`` module
|
||||
-------------------
|
||||
Core API
|
||||
--------
|
||||
|
||||
.. autoclass:: microdot.Microdot
|
||||
:members:
|
||||
@@ -14,51 +14,57 @@ API Reference
|
||||
:members:
|
||||
|
||||
|
||||
``websocket`` extension
|
||||
-----------------------
|
||||
WebSocket
|
||||
---------
|
||||
|
||||
.. automodule:: microdot.websocket
|
||||
:members:
|
||||
|
||||
``utemplate`` templating extension
|
||||
----------------------------------
|
||||
Server-Sent Events (SSE)
|
||||
------------------------
|
||||
|
||||
.. automodule:: microdot.sse
|
||||
:members:
|
||||
|
||||
Templates (uTemplate)
|
||||
---------------------
|
||||
|
||||
.. automodule:: microdot.utemplate
|
||||
:members:
|
||||
|
||||
``jinja`` templating extension
|
||||
------------------------------
|
||||
Templates (Jinja)
|
||||
-----------------
|
||||
|
||||
.. automodule:: microdot.jinja
|
||||
:members:
|
||||
|
||||
``session`` extension
|
||||
---------------------
|
||||
User Sessions
|
||||
-------------
|
||||
|
||||
.. automodule:: microdot.session
|
||||
:members:
|
||||
|
||||
``cors`` extension
|
||||
------------------
|
||||
Cross-Origin Resource Sharing (CORS)
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: microdot.cors
|
||||
:members:
|
||||
|
||||
``test_client`` extension
|
||||
-------------------------
|
||||
Test Client
|
||||
-----------
|
||||
|
||||
.. automodule:: microdot.test_client
|
||||
:members:
|
||||
|
||||
``asgi`` extension
|
||||
------------------
|
||||
ASGI
|
||||
----
|
||||
|
||||
.. autoclass:: microdot.asgi.Microdot
|
||||
:members:
|
||||
:exclude-members: shutdown, run
|
||||
|
||||
``wsgi`` extension
|
||||
-------------------
|
||||
WSGI
|
||||
----
|
||||
|
||||
.. autoclass:: microdot.wsgi.Microdot
|
||||
:members:
|
||||
|
||||
@@ -25,14 +25,15 @@ and incorporated into a custom MicroPython firmware.
|
||||
|
||||
Use the following guidelines to know what files to copy:
|
||||
|
||||
- For a minimal setup with only the base web server functionality, copy
|
||||
* For a minimal setup with only the base web server functionality, copy
|
||||
`microdot.py <https://github.com/miguelgrinberg/microdot/blob/main/src/microdot/microdot.py>`_
|
||||
into your project.
|
||||
- For a configuration that includes one or more optional extensions, create a
|
||||
* For a configuration that includes one or more optional extensions, create a
|
||||
*microdot* directory in your device and copy the following files:
|
||||
- `__init__.py <https://github.com/miguelgrinberg/microdot/blob/main/src/microdot/__init__.py>`_
|
||||
- `microdot.py <https://github.com/miguelgrinberg/microdot/blob/main/src/microdot/microdot.py>`_
|
||||
- any needed `extensions <https://github.com/miguelgrinberg/microdot/tree/main/src/microdot>`_.
|
||||
|
||||
* `__init__.py <https://github.com/miguelgrinberg/microdot/blob/main/src/microdot/__init__.py>`_
|
||||
* `microdot.py <https://github.com/miguelgrinberg/microdot/blob/main/src/microdot/microdot.py>`_
|
||||
* any needed `extensions <https://github.com/miguelgrinberg/microdot/tree/main/src/microdot>`_.
|
||||
|
||||
|
||||
Getting Started
|
||||
|
||||
Reference in New Issue
Block a user