From 091a4d303af4dc44db833d5ae42773e752ba7d61 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Sat, 17 Apr 2021 16:42:29 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=94=20Update=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/autodoc/engineer.rst | 65 ++++++++++++-------------------- docs/source/autodoc/index.rst | 2 +- docs/source/autodoc/lazy.rst | 3 +- docs/source/conf.py | 3 +- docs/source/index.rst | 4 +- docs/source/tutorials/index.rst | 11 ++++++ 6 files changed, 42 insertions(+), 46 deletions(-) create mode 100644 docs/source/tutorials/index.rst diff --git a/docs/source/autodoc/engineer.rst b/docs/source/autodoc/engineer.rst index 365ae15a..c68e3b74 100644 --- a/docs/source/autodoc/engineer.rst +++ b/docs/source/autodoc/engineer.rst @@ -4,76 +4,59 @@ .. automodule:: royalnet.engineer -``bullet`` ----------- - -.. automodule:: royalnet.engineer.bullet - - -``pda`` ----------- +``pda`` - Central connection unit +--------------------------------- .. automodule:: royalnet.engineer.pda - - -``contents`` -~~~~~~~~~~~~ - -.. automodule:: royalnet.engineer.bullet.contents :imported-members: -``projectiles`` -~~~~~~~~~~~~~~~ +``bullet`` - Data containers +---------------------------- -.. automodule:: royalnet.engineer.bullet.projectiles +.. automodule:: royalnet.engineer.bullet :imported-members: -``command`` ------------ - -.. automodule:: royalnet.engineer.command - - -``conversation`` ----------------- +``conversation`` - Conversation utilities +----------------------------------------- .. automodule:: royalnet.engineer.conversation + :special-members: __call__ -``dispenser`` -------------- +``dispenser`` - Event distributors +---------------------------------- .. automodule:: royalnet.engineer.dispenser -``sentry`` ----------- +``sentry`` - Event listeners +---------------------------- .. automodule:: royalnet.engineer.sentry :special-members: __or__ -``teleporter`` --------------- - -.. automodule:: royalnet.engineer.teleporter - - -``wrench`` ----------- +``wrench`` - Filters for Sentry +------------------------------- .. automodule:: royalnet.engineer.wrench -``discard`` ------------ +``discard`` - Special filter exception +-------------------------------------- .. automodule:: royalnet.engineer.discard -``exc`` -------- +``teleporter`` - Argument validators +------------------------------------ + +.. automodule:: royalnet.engineer.teleporter + + +``exc`` - General errors +------------------------ .. automodule:: royalnet.engineer.exc diff --git a/docs/source/autodoc/index.rst b/docs/source/autodoc/index.rst index 42b4a2b5..10b334b4 100644 --- a/docs/source/autodoc/index.rst +++ b/docs/source/autodoc/index.rst @@ -3,7 +3,7 @@ Autogenerated documentation Welcome to the autogenerated documentation of Royalnet 6! -It may be incomplete or outdated, as it is automatically updated. +The following pages are automatically generated from the docstrings of the various entities present in the Python code. .. toctree:: :maxdepth: 3 diff --git a/docs/source/autodoc/lazy.rst b/docs/source/autodoc/lazy.rst index f992f088..b0a502de 100644 --- a/docs/source/autodoc/lazy.rst +++ b/docs/source/autodoc/lazy.rst @@ -2,5 +2,4 @@ =================================== .. automodule:: royalnet.lazy - -.. todo:: Document this. \ No newline at end of file + :imported-members: diff --git a/docs/source/conf.py b/docs/source/conf.py index f53f6f9c..51a94e20 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -20,7 +20,7 @@ import pkg_resources project = 'royalnet' # noinspection PyShadowingBuiltins -copyright = '2020, Stefano Pigozzi' +copyright = '2021, Stefano Pigozzi' author = 'Stefano Pigozzi' # The full version, including alpha/beta/rc tags @@ -98,3 +98,4 @@ autodoc_default_options = { # -- Automodule settings ----------------------------------------------------- todo_include_todos = True + diff --git a/docs/source/index.rst b/docs/source/index.rst index 2b367982..d25c769a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,8 +8,9 @@ Table of contents ----------------- .. toctree:: - :maxdepth: 3 + :maxdepth: 2 + tutorials/index autodoc/index @@ -26,6 +27,7 @@ Indices and tables * :ref:`modindex` * :ref:`search` + To do ----- diff --git a/docs/source/tutorials/index.rst b/docs/source/tutorials/index.rst new file mode 100644 index 00000000..7dbfff22 --- /dev/null +++ b/docs/source/tutorials/index.rst @@ -0,0 +1,11 @@ +Tutorials +========= + +.. todo:: Write a tutorial on how to write a conversation. + +.. todo:: Write a tutorial on how to write a conversation pack. + +.. todo:: Write a tutorial on how to write a conversation runner. + +.. toctree:: + :maxdepth: 2