mirror of
https://github.com/RYGhub/royalnet.git
synced 2024-11-22 19:14:20 +00:00
Update documentation with the current state of things
This commit is contained in:
parent
c5af6ede01
commit
68d7c0bda7
7 changed files with 13 additions and 96 deletions
|
@ -1,4 +0,0 @@
|
||||||
``alchemist`` - SQLAlchemy utilities
|
|
||||||
====================================
|
|
||||||
|
|
||||||
.. automodule:: royalnet.alchemist
|
|
|
@ -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
|
|
|
@ -1,15 +1,19 @@
|
||||||
Autogenerated documentation
|
#############
|
||||||
===========================
|
API reference
|
||||||
|
#############
|
||||||
|
|
||||||
Welcome to the autogenerated documentation of Royalnet 6!
|
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.
|
The following pages are automatically generated from the docstrings of the various entities present in the Python code.
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 3
|
|
||||||
|
|
||||||
alchemist
|
:mod:`royalnet`
|
||||||
engineer
|
===============
|
||||||
lazy
|
|
||||||
royaltyping
|
.. automodule:: royalnet
|
||||||
scrolls
|
|
||||||
|
|
||||||
|
:mod:`royalnet.validation`
|
||||||
|
==========================
|
||||||
|
|
||||||
|
.. automodule:: royalnet.validation
|
||||||
|
|
|
@ -1,5 +0,0 @@
|
||||||
``lazy`` - Lazy-load global objects
|
|
||||||
===================================
|
|
||||||
|
|
||||||
.. automodule:: royalnet.lazy
|
|
||||||
:imported-members:
|
|
|
@ -1,4 +0,0 @@
|
||||||
``scrolls`` - Configuration loader
|
|
||||||
==================================
|
|
||||||
|
|
||||||
.. automodule:: royalnet.scrolls
|
|
|
@ -10,7 +10,6 @@ Table of contents
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
tutorials/index
|
|
||||||
autodoc/index
|
autodoc/index
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -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
|
|
Loading…
Reference in a new issue