diff --git a/docs/source/autodoc/alchemist.rst b/docs/source/autodoc/alchemist.rst deleted file mode 100644 index 8c148660..00000000 --- a/docs/source/autodoc/alchemist.rst +++ /dev/null @@ -1,4 +0,0 @@ -``alchemist`` - SQLAlchemy utilities -==================================== - -.. automodule:: royalnet.alchemist diff --git a/docs/source/autodoc/engineer.rst b/docs/source/autodoc/engineer.rst deleted file mode 100644 index c68e3b74..00000000 --- a/docs/source/autodoc/engineer.rst +++ /dev/null @@ -1,62 +0,0 @@ -``engineer`` - Chatbot framework -================================ - -.. automodule:: royalnet.engineer - - -``pda`` - Central connection unit ---------------------------------- - -.. automodule:: royalnet.engineer.pda - :imported-members: - - -``bullet`` - Data containers ----------------------------- - -.. automodule:: royalnet.engineer.bullet - :imported-members: - - -``conversation`` - Conversation utilities ------------------------------------------ - -.. automodule:: royalnet.engineer.conversation - :special-members: __call__ - - -``dispenser`` - Event distributors ----------------------------------- - -.. automodule:: royalnet.engineer.dispenser - - -``sentry`` - Event listeners ----------------------------- - -.. automodule:: royalnet.engineer.sentry - :special-members: __or__ - - -``wrench`` - Filters for Sentry -------------------------------- - -.. automodule:: royalnet.engineer.wrench - - -``discard`` - Special filter exception --------------------------------------- - -.. automodule:: royalnet.engineer.discard - - -``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 10b334b4..82febe8d 100644 --- a/docs/source/autodoc/index.rst +++ b/docs/source/autodoc/index.rst @@ -1,15 +1,19 @@ -Autogenerated documentation -=========================== +############# +API reference +############# Welcome to the autogenerated documentation of Royalnet 6! The following pages are automatically generated from the docstrings of the various entities present in the Python code. -.. toctree:: - :maxdepth: 3 - alchemist - engineer - lazy - royaltyping - scrolls +:mod:`royalnet` +=============== + +.. automodule:: royalnet + + +:mod:`royalnet.validation` +========================== + +.. automodule:: royalnet.validation diff --git a/docs/source/autodoc/lazy.rst b/docs/source/autodoc/lazy.rst deleted file mode 100644 index b0a502de..00000000 --- a/docs/source/autodoc/lazy.rst +++ /dev/null @@ -1,5 +0,0 @@ -``lazy`` - Lazy-load global objects -=================================== - -.. automodule:: royalnet.lazy - :imported-members: diff --git a/docs/source/autodoc/scrolls.rst b/docs/source/autodoc/scrolls.rst deleted file mode 100644 index bb9ba601..00000000 --- a/docs/source/autodoc/scrolls.rst +++ /dev/null @@ -1,4 +0,0 @@ -``scrolls`` - Configuration loader -================================== - -.. automodule:: royalnet.scrolls diff --git a/docs/source/index.rst b/docs/source/index.rst index 40a1e7f9..83a217fc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,7 +10,6 @@ Table of contents .. toctree:: :maxdepth: 2 - tutorials/index autodoc/index diff --git a/docs/source/tutorials/index.rst b/docs/source/tutorials/index.rst deleted file mode 100644 index 7dbfff22..00000000 --- a/docs/source/tutorials/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -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