Add new api pages

2026-03-25 01:06:32 +01:00 · 2020-10-12 22:22:02 +02:00 · 2020-10-12 22:22:02 +02:00 · c20c832003
commit c20c832003
parent d03f80f430
29 changed files with 149 additions and 113 deletions
--- a/docs/source/api/evennia.accounts.rst
+++ b/docs/source/api/evennia.accounts.rst
@ -6,10 +6,11 @@ evennia.accounts
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.accounts.accounts
   evennia.accounts.admin
--- a/docs/source/api/evennia.commands.default.rst
+++ b/docs/source/api/evennia.commands.default.rst
@ -6,10 +6,11 @@ evennia.commands.default
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.commands.default.account
   evennia.commands.default.admin
--- a/docs/source/api/evennia.commands.rst
+++ b/docs/source/api/evennia.commands.rst
@ -6,20 +6,22 @@ evennia.commands
   :undoc-members:
   :show-inheritance:

-Subpackages
-----------
-
-.. toctree::
-
-   evennia.commands.default
-
-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.commands.cmdhandler
   evennia.commands.cmdparser
   evennia.commands.cmdset
   evennia.commands.cmdsethandler
   evennia.commands.command
+
+Packages/folders
+----------------
+
+.. toctree::
+   :maxdepth: 
+
+   evennia.commands.default
--- a/docs/source/api/evennia.comms.rst
+++ b/docs/source/api/evennia.comms.rst
@ -6,10 +6,11 @@ evennia.comms
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.comms.admin
   evennia.comms.channelhandler
--- a/docs/source/api/evennia.contrib.ingame_python.rst
+++ b/docs/source/api/evennia.contrib.ingame_python.rst
@ -6,10 +6,11 @@ evennia.contrib.ingame\_python
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.contrib.ingame_python.callbackhandler
   evennia.contrib.ingame_python.commands
--- a/docs/source/api/evennia.contrib.rst
+++ b/docs/source/api/evennia.contrib.rst
@ -6,21 +6,11 @@ evennia.contrib
   :undoc-members:
   :show-inheritance:

-Subpackages
-----------
-
-.. toctree::
-
-   evennia.contrib.ingame_python
-   evennia.contrib.security
-   evennia.contrib.turnbattle
-   evennia.contrib.tutorial_examples
-   evennia.contrib.tutorial_world
-
-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.contrib.barter
   evennia.contrib.building_menu
@ -48,3 +38,15 @@ Submodules
   evennia.contrib.tree_select
   evennia.contrib.unixcommand
   evennia.contrib.wilderness
+
+Packages/folders
+----------------
+
+.. toctree::
+   :maxdepth: 
+
+   evennia.contrib.ingame_python
+   evennia.contrib.security
+   evennia.contrib.turnbattle
+   evennia.contrib.tutorial_examples
+   evennia.contrib.tutorial_world
--- a/docs/source/api/evennia.contrib.security.auditing.rst
+++ b/docs/source/api/evennia.contrib.security.auditing.rst
@ -6,10 +6,11 @@ evennia.contrib.security.auditing
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.contrib.security.auditing.outputs
   evennia.contrib.security.auditing.server
--- a/docs/source/api/evennia.contrib.security.rst
+++ b/docs/source/api/evennia.contrib.security.rst
@ -6,9 +6,10 @@ evennia.contrib.security
   :undoc-members:
   :show-inheritance:

-Subpackages
-----------
+Packages/folders
+----------------

 .. toctree::
+   :maxdepth: 

   evennia.contrib.security.auditing
--- a/docs/source/api/evennia.contrib.turnbattle.rst
+++ b/docs/source/api/evennia.contrib.turnbattle.rst
@ -6,10 +6,11 @@ evennia.contrib.turnbattle
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.contrib.turnbattle.tb_basic
   evennia.contrib.turnbattle.tb_equip
--- a/docs/source/api/evennia.contrib.tutorial_examples.rst
+++ b/docs/source/api/evennia.contrib.tutorial_examples.rst
@ -6,10 +6,11 @@ evennia.contrib.tutorial\_examples
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.contrib.tutorial_examples.bodyfunctions
   evennia.contrib.tutorial_examples.cmdset_red_button
--- a/docs/source/api/evennia.contrib.tutorial_world.rst
+++ b/docs/source/api/evennia.contrib.tutorial_world.rst
@ -6,10 +6,11 @@ evennia.contrib.tutorial\_world
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.contrib.tutorial_world.intro_menu
   evennia.contrib.tutorial_world.mob
--- a/docs/source/api/evennia.help.rst
+++ b/docs/source/api/evennia.help.rst
@ -6,10 +6,11 @@ evennia.help
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.help.admin
   evennia.help.manager
--- a/docs/source/api/evennia.locks.rst
+++ b/docs/source/api/evennia.locks.rst
@ -6,10 +6,11 @@ evennia.locks
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.locks.lockfuncs
   evennia.locks.lockhandler
--- a/docs/source/api/evennia.objects.rst
+++ b/docs/source/api/evennia.objects.rst
@ -6,10 +6,11 @@ evennia.objects
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.objects.admin
   evennia.objects.manager
--- a/docs/source/api/evennia.prototypes.rst
+++ b/docs/source/api/evennia.prototypes.rst
@ -6,10 +6,11 @@ evennia.prototypes
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.prototypes.menus
   evennia.prototypes.protfuncs
--- a/docs/source/api/evennia.rst
+++ b/docs/source/api/evennia.rst
@ -6,10 +6,19 @@ evennia
   :undoc-members:
   :show-inheritance:

-Subpackages
-----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 
+
+   evennia.settings_default
+
+Packages/folders
+----------------
+
+.. toctree::
+   :maxdepth: 

   evennia.accounts
   evennia.commands
@ -24,10 +33,3 @@ Subpackages
   evennia.typeclasses
   evennia.utils
   evennia.web
-
-Submodules
----------
-
-.. toctree::
-
-   evennia.settings_default
--- a/docs/source/api/evennia.scripts.rst
+++ b/docs/source/api/evennia.scripts.rst
@ -6,10 +6,11 @@ evennia.scripts
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.scripts.admin
   evennia.scripts.manager
--- a/docs/source/api/evennia.server.game_index_client.rst
+++ b/docs/source/api/evennia.server.game_index_client.rst
@ -6,10 +6,11 @@ evennia.server.game\_index\_client
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.server.game_index_client.client
   evennia.server.game_index_client.service
--- a/docs/source/api/evennia.server.portal.rst
+++ b/docs/source/api/evennia.server.portal.rst
@ -6,10 +6,11 @@ evennia.server.portal
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.server.portal.amp
   evennia.server.portal.amp_server
--- a/docs/source/api/evennia.server.profiling.rst
+++ b/docs/source/api/evennia.server.profiling.rst
@ -6,10 +6,11 @@ evennia.server.profiling
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.server.profiling.dummyrunner
   evennia.server.profiling.dummyrunner_settings
--- a/docs/source/api/evennia.server.rst
+++ b/docs/source/api/evennia.server.rst
@ -6,19 +6,11 @@ evennia.server
   :undoc-members:
   :show-inheritance:

-Subpackages
-----------
-
-.. toctree::
-
-   evennia.server.game_index_client
-   evennia.server.portal
-   evennia.server.profiling
-
-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.server.admin
   evennia.server.amp_client
@ -37,3 +29,13 @@ Submodules
   evennia.server.throttle
   evennia.server.validators
   evennia.server.webserver
+
+Packages/folders
+----------------
+
+.. toctree::
+   :maxdepth: 
+
+   evennia.server.game_index_client
+   evennia.server.portal
+   evennia.server.profiling
--- a/docs/source/api/evennia.typeclasses.rst
+++ b/docs/source/api/evennia.typeclasses.rst
@ -6,10 +6,11 @@ evennia.typeclasses
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.typeclasses.admin
   evennia.typeclasses.attributes
--- a/docs/source/api/evennia.utils.idmapper.rst
+++ b/docs/source/api/evennia.utils.idmapper.rst
@ -6,10 +6,11 @@ evennia.utils.idmapper
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.utils.idmapper.manager
   evennia.utils.idmapper.models
--- a/docs/source/api/evennia.utils.rst
+++ b/docs/source/api/evennia.utils.rst
@ -6,17 +6,11 @@ evennia.utils
   :undoc-members:
   :show-inheritance:

-Subpackages
-----------
-
-.. toctree::
-
-   evennia.utils.idmapper
-
-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.utils.ansi
   evennia.utils.batchprocessors
@ -39,3 +33,11 @@ Submodules
   evennia.utils.text2html
   evennia.utils.utils
   evennia.utils.validatorfuncs
+
+Packages/folders
+----------------
+
+.. toctree::
+   :maxdepth: 
+
+   evennia.utils.idmapper
--- a/docs/source/api/evennia.web.rst
+++ b/docs/source/api/evennia.web.rst
@ -6,18 +6,20 @@ evennia.web
   :undoc-members:
   :show-inheritance:

-Subpackages
-----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 
+
+   evennia.web.urls
+
+Packages/folders
+----------------
+
+.. toctree::
+   :maxdepth: 

   evennia.web.utils
   evennia.web.webclient
   evennia.web.website
-
-Submodules
----------
-
-.. toctree::
-
-   evennia.web.urls
--- a/docs/source/api/evennia.web.utils.rst
+++ b/docs/source/api/evennia.web.utils.rst
@ -6,10 +6,11 @@ evennia.web.utils
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.web.utils.backends
   evennia.web.utils.general_context
--- a/docs/source/api/evennia.web.webclient.rst
+++ b/docs/source/api/evennia.web.webclient.rst
@ -6,10 +6,11 @@ evennia.web.webclient
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.web.webclient.urls
   evennia.web.webclient.views
--- a/docs/source/api/evennia.web.website.rst
+++ b/docs/source/api/evennia.web.website.rst
@ -6,19 +6,21 @@ evennia.web.website
   :undoc-members:
   :show-inheritance:

-Subpackages
-----------
-
-.. toctree::
-
-   evennia.web.website.templatetags
-
-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.web.website.forms
   evennia.web.website.tests
   evennia.web.website.urls
   evennia.web.website.views
+
+Packages/folders
+----------------
+
+.. toctree::
+   :maxdepth: 
+
+   evennia.web.website.templatetags
--- a/docs/source/api/evennia.web.website.templatetags.rst
+++ b/docs/source/api/evennia.web.website.templatetags.rst
@ -6,9 +6,10 @@ evennia.web.website.templatetags
   :undoc-members:
   :show-inheritance:

-Submodules
----------
+Modules
+-------

 .. toctree::
+   :maxdepth: 

   evennia.web.website.templatetags.addclass