Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
radiac committed May 19, 2024
1 parent e95bd1a commit 6c7a039
Show file tree
Hide file tree
Showing 4 changed files with 83 additions and 34 deletions.
2 changes: 1 addition & 1 deletion docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ First, install mara with::

pip install mara

See :doc:`installation` for more options and details.
See :doc:`install` for more options and details.


A minimal service
Expand Down
74 changes: 42 additions & 32 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,48 +1,52 @@
#
# This file is autogenerated by pip-compile with python 3.10
# To update, run:
# This file is autogenerated by pip-compile with Python 3.12
# by the following command:
#
# pip-compile requirements.in
# pip-compile
#
-e git+https://github.com/radiac/sphinx_radiac_theme.git#egg=sphinx_radiac_theme
# via -r requirements.in
alabaster==0.7.12
alabaster==0.7.16
# via sphinx
babel==2.11.0
anyio==4.3.0
# via
# starlette
# watchfiles
babel==2.15.0
# via sphinx
certifi==2022.9.24
certifi==2024.2.2
# via requests
charset-normalizer==2.1.1
charset-normalizer==3.3.2
# via requests
click==8.1.7
# via uvicorn
colorama==0.4.6
# via sphinx-autobuild
docutils==0.17.1
# via
# sphinx
# sphinx-gitref
# sphinx-radiac-theme
idna==3.4
# via requests
h11==0.14.0
# via uvicorn
idna==3.7
# via
# anyio
# requests
imagesize==1.4.1
# via sphinx
jinja2==3.1.2
jinja2==3.1.4
# via sphinx
livereload==2.6.3
# via sphinx-autobuild
markupsafe==2.1.1
markupsafe==2.1.5
# via jinja2
packaging==21.3
packaging==24.0
# via sphinx
pygments==2.13.0
pygments==2.18.0
# via sphinx
pyparsing==3.0.9
# via packaging
pytz==2022.6
# via babel
requests==2.28.1
requests==2.31.0
# via sphinx
six==1.16.0
# via livereload
sniffio==1.3.1
# via anyio
snowballstemmer==2.2.0
# via sphinx
sphinx==5.3.0
Expand All @@ -51,23 +55,29 @@ sphinx==5.3.0
# sphinx-autobuild
# sphinx-gitref
# sphinx-radiac-theme
sphinx-autobuild==2021.3.14
sphinx-autobuild==2024.4.16
# via -r requirements.in
sphinx-gitref==0.2.1
sphinx-gitref==0.3.0
# via -r requirements.in
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-applehelp==1.0.8
# via sphinx
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-devhelp==1.0.6
# via sphinx
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-htmlhelp==2.0.5
# via sphinx
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-qthelp==1.0.7
# via sphinx
sphinxcontrib-serializinghtml==1.1.5
sphinxcontrib-serializinghtml==1.1.10
# via sphinx
tornado==6.2
# via livereload
urllib3==1.26.12
starlette==0.37.2
# via sphinx-autobuild
urllib3==2.2.1
# via requests
uvicorn==0.29.0
# via sphinx-autobuild
watchfiles==0.21.0
# via sphinx-autobuild
websockets==12.0
# via sphinx-autobuild
39 changes: 39 additions & 0 deletions docs/servers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,42 @@ This wraps the ``SocketServer`` to read and write text ``str``.
.. autoclass:: mara.servers.socket.TextConnection
:members:
:show-inheritance:


TelnetServer
============

This wraps ``telnetlib3`` to provide a socket with telnet protocol support.

.. autoclass:: mara.servers.telnet.TelnetServer
:members:
:show-inheritance:

.. autoclass:: mara.servers.telnet.TelnetConnection
:members:
:show-inheritance:


HttpServer
==========

This wraps ``aiohttp`` to serve HTTP requests

.. autoclass:: mara.servers.http.HttpServer
:members:
:show-inheritance:


WebSocketServer
---------------

Create a websocket server using ``HttpServer.create_websocket(..)``


.. autoclass:: mara.servers.http.WebSocketServer
:members:
:show-inheritance:

.. autoclass:: mara.servers.http.WebSocketConnection
:members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/upgrading.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Upgrading
=========

For an overview of what has changed between versions, see the :ref:`changelog`.
For an overview of what has changed between versions, see the :doc:`changelog`.


Instructions
Expand Down

0 comments on commit 6c7a039

Please sign in to comment.