📔 Update documentation

docs/source/autodoc/engineer.rst

@@ -4,76 +4,59 @@
 .. automodule:: royalnet.engineer
 
 
-``bullet``
+``pda`` - Central connection unit
-----------
+---------------------------------
-
-.. automodule:: royalnet.engineer.bullet
-
-
-``pda``
-----------
 
 .. 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``
+``conversation`` - Conversation utilities
------------
+-----------------------------------------
-
-.. automodule:: royalnet.engineer.command
-
-
-``conversation``
-----------------
 
 .. 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``
+``wrench`` - Filters for Sentry
---------------
+-------------------------------
-
-.. automodule:: royalnet.engineer.teleporter
-
-
-``wrench``
-----------
 
 .. 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

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

docs/source/autodoc/lazy.rst

@@ -2,5 +2,4 @@
 ===================================
 
 .. automodule:: royalnet.lazy
-
+   :imported-members:
-.. todo:: Document this.

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
+

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
 -----
 

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