From c20c83200355bee8383b178f8bd97237b80e1adc Mon Sep 17 00:00:00 2001 From: Griatch Date: Mon, 12 Oct 2020 22:22:02 +0200 Subject: [PATCH] Add new api pages --- docs/source/api/evennia.accounts.rst | 5 ++-- docs/source/api/evennia.commands.default.rst | 5 ++-- docs/source/api/evennia.commands.rst | 20 +++++++------ docs/source/api/evennia.comms.rst | 5 ++-- .../api/evennia.contrib.ingame_python.rst | 5 ++-- docs/source/api/evennia.contrib.rst | 28 ++++++++++--------- .../api/evennia.contrib.security.auditing.rst | 5 ++-- docs/source/api/evennia.contrib.security.rst | 5 ++-- .../source/api/evennia.contrib.turnbattle.rst | 5 ++-- .../api/evennia.contrib.tutorial_examples.rst | 5 ++-- .../api/evennia.contrib.tutorial_world.rst | 5 ++-- docs/source/api/evennia.help.rst | 5 ++-- docs/source/api/evennia.locks.rst | 5 ++-- docs/source/api/evennia.objects.rst | 5 ++-- docs/source/api/evennia.prototypes.rst | 5 ++-- docs/source/api/evennia.rst | 20 +++++++------ docs/source/api/evennia.scripts.rst | 5 ++-- .../api/evennia.server.game_index_client.rst | 5 ++-- docs/source/api/evennia.server.portal.rst | 5 ++-- docs/source/api/evennia.server.profiling.rst | 5 ++-- docs/source/api/evennia.server.rst | 24 ++++++++-------- docs/source/api/evennia.typeclasses.rst | 5 ++-- docs/source/api/evennia.utils.idmapper.rst | 5 ++-- docs/source/api/evennia.utils.rst | 20 +++++++------ docs/source/api/evennia.web.rst | 20 +++++++------ docs/source/api/evennia.web.utils.rst | 5 ++-- docs/source/api/evennia.web.webclient.rst | 5 ++-- docs/source/api/evennia.web.website.rst | 20 +++++++------ .../api/evennia.web.website.templatetags.rst | 5 ++-- 29 files changed, 149 insertions(+), 113 deletions(-) diff --git a/docs/source/api/evennia.accounts.rst b/docs/source/api/evennia.accounts.rst index 87483bda1b..aeca4b74e3 100644 --- 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 diff --git a/docs/source/api/evennia.commands.default.rst b/docs/source/api/evennia.commands.default.rst index d565163dbe..34f6a75068 100644 --- 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 diff --git a/docs/source/api/evennia.commands.rst b/docs/source/api/evennia.commands.rst index 92fc209234..f8f42beb3a 100644 --- 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 diff --git a/docs/source/api/evennia.comms.rst b/docs/source/api/evennia.comms.rst index b9ad8f6690..b79fac0173 100644 --- 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 diff --git a/docs/source/api/evennia.contrib.ingame_python.rst b/docs/source/api/evennia.contrib.ingame_python.rst index fb638c737e..ac90266757 100644 --- 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 diff --git a/docs/source/api/evennia.contrib.rst b/docs/source/api/evennia.contrib.rst index abeba92ef5..2ed9e6eea1 100644 --- 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 diff --git a/docs/source/api/evennia.contrib.security.auditing.rst b/docs/source/api/evennia.contrib.security.auditing.rst index 46c062e2c8..f47b55652f 100644 --- 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 diff --git a/docs/source/api/evennia.contrib.security.rst b/docs/source/api/evennia.contrib.security.rst index 49aed18880..be575610ff 100644 --- 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 diff --git a/docs/source/api/evennia.contrib.turnbattle.rst b/docs/source/api/evennia.contrib.turnbattle.rst index 41724328c0..261d5483cf 100644 --- 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 diff --git a/docs/source/api/evennia.contrib.tutorial_examples.rst b/docs/source/api/evennia.contrib.tutorial_examples.rst index 85ab0aace5..ea17f7be0b 100644 --- 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 diff --git a/docs/source/api/evennia.contrib.tutorial_world.rst b/docs/source/api/evennia.contrib.tutorial_world.rst index 5f0f77d58c..f98950921e 100644 --- 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 diff --git a/docs/source/api/evennia.help.rst b/docs/source/api/evennia.help.rst index e805f83d0e..03c832547d 100644 --- 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 diff --git a/docs/source/api/evennia.locks.rst b/docs/source/api/evennia.locks.rst index 66fdbf2790..8077815a20 100644 --- 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 diff --git a/docs/source/api/evennia.objects.rst b/docs/source/api/evennia.objects.rst index 14a5a9ac85..61ad300c36 100644 --- 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 diff --git a/docs/source/api/evennia.prototypes.rst b/docs/source/api/evennia.prototypes.rst index 07b864635c..7508e3e89e 100644 --- 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 diff --git a/docs/source/api/evennia.rst b/docs/source/api/evennia.rst index 0f93df5333..19fa73608e 100644 --- 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 diff --git a/docs/source/api/evennia.scripts.rst b/docs/source/api/evennia.scripts.rst index 56af96ff8d..0e4ee2e78c 100644 --- 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 diff --git a/docs/source/api/evennia.server.game_index_client.rst b/docs/source/api/evennia.server.game_index_client.rst index 451541bbb4..116340b6ef 100644 --- 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 diff --git a/docs/source/api/evennia.server.portal.rst b/docs/source/api/evennia.server.portal.rst index 612f0e89d7..b0026aadca 100644 --- 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 diff --git a/docs/source/api/evennia.server.profiling.rst b/docs/source/api/evennia.server.profiling.rst index 0279e7c009..4d3e697436 100644 --- 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 diff --git a/docs/source/api/evennia.server.rst b/docs/source/api/evennia.server.rst index 245655bc53..181d166fda 100644 --- 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 diff --git a/docs/source/api/evennia.typeclasses.rst b/docs/source/api/evennia.typeclasses.rst index a9be581e96..516adc4649 100644 --- 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 diff --git a/docs/source/api/evennia.utils.idmapper.rst b/docs/source/api/evennia.utils.idmapper.rst index 48c3a13e42..8cf3336fcc 100644 --- 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 diff --git a/docs/source/api/evennia.utils.rst b/docs/source/api/evennia.utils.rst index 9814f6ab75..5d2d66d8cf 100644 --- 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 diff --git a/docs/source/api/evennia.web.rst b/docs/source/api/evennia.web.rst index 2bca5a978c..45d4522d99 100644 --- 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 diff --git a/docs/source/api/evennia.web.utils.rst b/docs/source/api/evennia.web.utils.rst index c3530761f0..f7a5f6548e 100644 --- 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 diff --git a/docs/source/api/evennia.web.webclient.rst b/docs/source/api/evennia.web.webclient.rst index af4f24a48b..68ebd09e28 100644 --- 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 diff --git a/docs/source/api/evennia.web.website.rst b/docs/source/api/evennia.web.website.rst index 2a00cda37c..46921867ce 100644 --- 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 diff --git a/docs/source/api/evennia.web.website.templatetags.rst b/docs/source/api/evennia.web.website.templatetags.rst index 743e1c7ac2..dedfb05a50 100644 --- 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