From c7fb61de0f9341fb716440e2aa754143473813c7 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sat, 29 May 2021 13:48:53 +0200 Subject: [PATCH] Update doc strings --- docs/source/Components/Web-API.md | 2 +- docs/source/api/evennia.accounts.rst | 1 - docs/source/api/evennia.comms.admin.rst | 7 ------ docs/source/api/evennia.comms.rst | 1 - docs/source/api/evennia.help.admin.rst | 7 ------ docs/source/api/evennia.help.rst | 1 - docs/source/api/evennia.objects.admin.rst | 7 ------ docs/source/api/evennia.objects.rst | 1 - docs/source/api/evennia.scripts.admin.rst | 7 ------ docs/source/api/evennia.scripts.rst | 1 - docs/source/api/evennia.server.rst | 1 - docs/source/api/evennia.typeclasses.rst | 1 - .../source/api/evennia.web.admin.accounts.rst | 7 ++++++ .../api/evennia.web.admin.attributes.rst | 7 ++++++ docs/source/api/evennia.web.admin.comms.rst | 7 ++++++ .../api/evennia.web.admin.frontpage.rst | 7 ++++++ ...s.admin.rst => evennia.web.admin.help.rst} | 4 ++-- ...dmin.rst => evennia.web.admin.objects.rst} | 4 ++-- docs/source/api/evennia.web.admin.rst | 24 +++++++++++++++++++ docs/source/api/evennia.web.admin.scripts.rst | 7 ++++++ docs/source/api/evennia.web.admin.server.rst | 7 ++++++ docs/source/api/evennia.web.admin.tags.rst | 7 ++++++ docs/source/api/evennia.web.admin.urls.rst | 7 ++++++ docs/source/api/evennia.web.admin.utils.rst | 7 ++++++ ...ver.admin.rst => evennia.web.api.root.rst} | 4 ++-- docs/source/api/evennia.web.api.rst | 1 + docs/source/api/evennia.web.rst | 2 ++ .../api/evennia.web.templatetags.addclass.rst | 7 ++++++ docs/source/api/evennia.web.templatetags.rst | 14 +++++++++++ .../api/evennia.web.utils.adminsite.rst | 7 ++++++ docs/source/api/evennia.web.utils.rst | 1 + docs/source/api/evennia.web.website.rst | 3 +-- ...nnia.web.website.templatetags.addclass.rst | 7 ------ .../api/evennia.web.website.templatetags.rst | 14 ----------- .../evennia.web.website.views.accounts.rst | 7 ++++++ .../evennia.web.website.views.channels.rst | 7 ++++++ .../evennia.web.website.views.characters.rst | 7 ++++++ .../api/evennia.web.website.views.errors.rst | 7 ++++++ .../api/evennia.web.website.views.help.rst | 7 ++++++ .../api/evennia.web.website.views.index.rst | 7 ++++++ .../api/evennia.web.website.views.mixins.rst | 7 ++++++ .../api/evennia.web.website.views.objects.rst | 7 ++++++ docs/source/api/evennia.web.website.views.rst | 16 ++++++++++++- docs/source/toc.md | 2 +- evennia/typeclasses/models.py | 21 ++++++++-------- evennia/utils/evmore.py | 7 +++--- evennia/web/urls.py | 22 ++++++++--------- 47 files changed, 224 insertions(+), 92 deletions(-) delete mode 100644 docs/source/api/evennia.comms.admin.rst delete mode 100644 docs/source/api/evennia.help.admin.rst delete mode 100644 docs/source/api/evennia.objects.admin.rst delete mode 100644 docs/source/api/evennia.scripts.admin.rst create mode 100644 docs/source/api/evennia.web.admin.accounts.rst create mode 100644 docs/source/api/evennia.web.admin.attributes.rst create mode 100644 docs/source/api/evennia.web.admin.comms.rst create mode 100644 docs/source/api/evennia.web.admin.frontpage.rst rename docs/source/api/{evennia.accounts.admin.rst => evennia.web.admin.help.rst} (57%) rename docs/source/api/{evennia.typeclasses.admin.rst => evennia.web.admin.objects.rst} (56%) create mode 100644 docs/source/api/evennia.web.admin.rst create mode 100644 docs/source/api/evennia.web.admin.scripts.rst create mode 100644 docs/source/api/evennia.web.admin.server.rst create mode 100644 docs/source/api/evennia.web.admin.tags.rst create mode 100644 docs/source/api/evennia.web.admin.urls.rst create mode 100644 docs/source/api/evennia.web.admin.utils.rst rename docs/source/api/{evennia.server.admin.rst => evennia.web.api.root.rst} (58%) create mode 100644 docs/source/api/evennia.web.templatetags.addclass.rst create mode 100644 docs/source/api/evennia.web.templatetags.rst create mode 100644 docs/source/api/evennia.web.utils.adminsite.rst delete mode 100644 docs/source/api/evennia.web.website.templatetags.addclass.rst delete mode 100644 docs/source/api/evennia.web.website.templatetags.rst create mode 100644 docs/source/api/evennia.web.website.views.accounts.rst create mode 100644 docs/source/api/evennia.web.website.views.channels.rst create mode 100644 docs/source/api/evennia.web.website.views.characters.rst create mode 100644 docs/source/api/evennia.web.website.views.errors.rst create mode 100644 docs/source/api/evennia.web.website.views.help.rst create mode 100644 docs/source/api/evennia.web.website.views.index.rst create mode 100644 docs/source/api/evennia.web.website.views.mixins.rst create mode 100644 docs/source/api/evennia.web.website.views.objects.rst diff --git a/docs/source/Components/Web-API.md b/docs/source/Components/Web-API.md index ca64137265..3668c7ff35 100644 --- a/docs/source/Components/Web-API.md +++ b/docs/source/Components/Web-API.md @@ -108,7 +108,7 @@ Overall, reading up on [Django Rest Framework ViewSets](https://www.django-rest- other parts of their documentation is required for expanding and customizing the API. -Check out the [Website](Website) page for help on how to override code, templates +Check out the [Website](./Website) page for help on how to override code, templates and static files. - API templates (for the web-display) is located in `evennia/web/api/templates/rest_framework/` (it must be named such to allow override of the original REST framework templates). diff --git a/docs/source/api/evennia.accounts.rst b/docs/source/api/evennia.accounts.rst index a8a3173cfa..c543b6a2a1 100644 --- a/docs/source/api/evennia.accounts.rst +++ b/docs/source/api/evennia.accounts.rst @@ -12,7 +12,6 @@ evennia.accounts :maxdepth: 6 evennia.accounts.accounts - evennia.accounts.admin evennia.accounts.bots evennia.accounts.manager evennia.accounts.models diff --git a/docs/source/api/evennia.comms.admin.rst b/docs/source/api/evennia.comms.admin.rst deleted file mode 100644 index c80ae8d993..0000000000 --- a/docs/source/api/evennia.comms.admin.rst +++ /dev/null @@ -1,7 +0,0 @@ -evennia.comms.admin -========================== - -.. automodule:: evennia.comms.admin - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/evennia.comms.rst b/docs/source/api/evennia.comms.rst index 0ae919dbd3..fe7ea8d5b6 100644 --- a/docs/source/api/evennia.comms.rst +++ b/docs/source/api/evennia.comms.rst @@ -11,7 +11,6 @@ evennia.comms .. toctree:: :maxdepth: 6 - evennia.comms.admin evennia.comms.comms evennia.comms.managers evennia.comms.models diff --git a/docs/source/api/evennia.help.admin.rst b/docs/source/api/evennia.help.admin.rst deleted file mode 100644 index 050a9b6d41..0000000000 --- a/docs/source/api/evennia.help.admin.rst +++ /dev/null @@ -1,7 +0,0 @@ -evennia.help.admin -========================= - -.. automodule:: evennia.help.admin - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/evennia.help.rst b/docs/source/api/evennia.help.rst index 6c737f8390..fe2b792ea6 100644 --- a/docs/source/api/evennia.help.rst +++ b/docs/source/api/evennia.help.rst @@ -11,7 +11,6 @@ evennia.help .. toctree:: :maxdepth: 6 - evennia.help.admin evennia.help.filehelp evennia.help.manager evennia.help.models diff --git a/docs/source/api/evennia.objects.admin.rst b/docs/source/api/evennia.objects.admin.rst deleted file mode 100644 index 6e8c0cfa96..0000000000 --- a/docs/source/api/evennia.objects.admin.rst +++ /dev/null @@ -1,7 +0,0 @@ -evennia.objects.admin -============================ - -.. automodule:: evennia.objects.admin - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/evennia.objects.rst b/docs/source/api/evennia.objects.rst index 3f46bb249d..b31bc08167 100644 --- a/docs/source/api/evennia.objects.rst +++ b/docs/source/api/evennia.objects.rst @@ -11,7 +11,6 @@ evennia.objects .. toctree:: :maxdepth: 6 - evennia.objects.admin evennia.objects.manager evennia.objects.models evennia.objects.objects diff --git a/docs/source/api/evennia.scripts.admin.rst b/docs/source/api/evennia.scripts.admin.rst deleted file mode 100644 index 3825a583d3..0000000000 --- a/docs/source/api/evennia.scripts.admin.rst +++ /dev/null @@ -1,7 +0,0 @@ -evennia.scripts.admin -============================ - -.. automodule:: evennia.scripts.admin - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/evennia.scripts.rst b/docs/source/api/evennia.scripts.rst index 6fab193f27..89c551ee98 100644 --- a/docs/source/api/evennia.scripts.rst +++ b/docs/source/api/evennia.scripts.rst @@ -11,7 +11,6 @@ evennia.scripts .. toctree:: :maxdepth: 6 - evennia.scripts.admin evennia.scripts.manager evennia.scripts.models evennia.scripts.monitorhandler diff --git a/docs/source/api/evennia.server.rst b/docs/source/api/evennia.server.rst index 149333d34a..2e95dfc084 100644 --- a/docs/source/api/evennia.server.rst +++ b/docs/source/api/evennia.server.rst @@ -11,7 +11,6 @@ evennia.server .. toctree:: :maxdepth: 6 - evennia.server.admin evennia.server.amp_client evennia.server.connection_wizard evennia.server.deprecations diff --git a/docs/source/api/evennia.typeclasses.rst b/docs/source/api/evennia.typeclasses.rst index 9abc0e14f9..875b1491ab 100644 --- a/docs/source/api/evennia.typeclasses.rst +++ b/docs/source/api/evennia.typeclasses.rst @@ -11,7 +11,6 @@ evennia.typeclasses .. toctree:: :maxdepth: 6 - evennia.typeclasses.admin evennia.typeclasses.attributes evennia.typeclasses.managers evennia.typeclasses.models diff --git a/docs/source/api/evennia.web.admin.accounts.rst b/docs/source/api/evennia.web.admin.accounts.rst new file mode 100644 index 0000000000..39a64ce74c --- /dev/null +++ b/docs/source/api/evennia.web.admin.accounts.rst @@ -0,0 +1,7 @@ +evennia.web.admin.accounts +================================= + +.. automodule:: evennia.web.admin.accounts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.attributes.rst b/docs/source/api/evennia.web.admin.attributes.rst new file mode 100644 index 0000000000..a633f3ed5a --- /dev/null +++ b/docs/source/api/evennia.web.admin.attributes.rst @@ -0,0 +1,7 @@ +evennia.web.admin.attributes +=================================== + +.. automodule:: evennia.web.admin.attributes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.comms.rst b/docs/source/api/evennia.web.admin.comms.rst new file mode 100644 index 0000000000..432abaa402 --- /dev/null +++ b/docs/source/api/evennia.web.admin.comms.rst @@ -0,0 +1,7 @@ +evennia.web.admin.comms +============================== + +.. automodule:: evennia.web.admin.comms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.frontpage.rst b/docs/source/api/evennia.web.admin.frontpage.rst new file mode 100644 index 0000000000..032c948c42 --- /dev/null +++ b/docs/source/api/evennia.web.admin.frontpage.rst @@ -0,0 +1,7 @@ +evennia.web.admin.frontpage +================================== + +.. automodule:: evennia.web.admin.frontpage + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.accounts.admin.rst b/docs/source/api/evennia.web.admin.help.rst similarity index 57% rename from docs/source/api/evennia.accounts.admin.rst rename to docs/source/api/evennia.web.admin.help.rst index 6c63cee11c..87b2f22c2f 100644 --- a/docs/source/api/evennia.accounts.admin.rst +++ b/docs/source/api/evennia.web.admin.help.rst @@ -1,7 +1,7 @@ -evennia.accounts.admin +evennia.web.admin.help ============================= -.. automodule:: evennia.accounts.admin +.. automodule:: evennia.web.admin.help :members: :undoc-members: :show-inheritance: diff --git a/docs/source/api/evennia.typeclasses.admin.rst b/docs/source/api/evennia.web.admin.objects.rst similarity index 56% rename from docs/source/api/evennia.typeclasses.admin.rst rename to docs/source/api/evennia.web.admin.objects.rst index 48b745cfcd..54a674e71e 100644 --- a/docs/source/api/evennia.typeclasses.admin.rst +++ b/docs/source/api/evennia.web.admin.objects.rst @@ -1,7 +1,7 @@ -evennia.typeclasses.admin +evennia.web.admin.objects ================================ -.. automodule:: evennia.typeclasses.admin +.. automodule:: evennia.web.admin.objects :members: :undoc-members: :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.rst b/docs/source/api/evennia.web.admin.rst new file mode 100644 index 0000000000..8b01fdb670 --- /dev/null +++ b/docs/source/api/evennia.web.admin.rst @@ -0,0 +1,24 @@ +evennia.web.admin +========================= + +.. automodule:: evennia.web.admin + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.web.admin.accounts + evennia.web.admin.attributes + evennia.web.admin.comms + evennia.web.admin.frontpage + evennia.web.admin.help + evennia.web.admin.objects + evennia.web.admin.scripts + evennia.web.admin.server + evennia.web.admin.tags + evennia.web.admin.urls + evennia.web.admin.utils diff --git a/docs/source/api/evennia.web.admin.scripts.rst b/docs/source/api/evennia.web.admin.scripts.rst new file mode 100644 index 0000000000..b13290aeea --- /dev/null +++ b/docs/source/api/evennia.web.admin.scripts.rst @@ -0,0 +1,7 @@ +evennia.web.admin.scripts +================================ + +.. automodule:: evennia.web.admin.scripts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.server.rst b/docs/source/api/evennia.web.admin.server.rst new file mode 100644 index 0000000000..7c8b09ce43 --- /dev/null +++ b/docs/source/api/evennia.web.admin.server.rst @@ -0,0 +1,7 @@ +evennia.web.admin.server +=============================== + +.. automodule:: evennia.web.admin.server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.tags.rst b/docs/source/api/evennia.web.admin.tags.rst new file mode 100644 index 0000000000..b3cf2445a1 --- /dev/null +++ b/docs/source/api/evennia.web.admin.tags.rst @@ -0,0 +1,7 @@ +evennia.web.admin.tags +============================= + +.. automodule:: evennia.web.admin.tags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.urls.rst b/docs/source/api/evennia.web.admin.urls.rst new file mode 100644 index 0000000000..9bd1651964 --- /dev/null +++ b/docs/source/api/evennia.web.admin.urls.rst @@ -0,0 +1,7 @@ +evennia.web.admin.urls +============================= + +.. automodule:: evennia.web.admin.urls + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.admin.utils.rst b/docs/source/api/evennia.web.admin.utils.rst new file mode 100644 index 0000000000..7f62f621f7 --- /dev/null +++ b/docs/source/api/evennia.web.admin.utils.rst @@ -0,0 +1,7 @@ +evennia.web.admin.utils +============================== + +.. automodule:: evennia.web.admin.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.admin.rst b/docs/source/api/evennia.web.api.root.rst similarity index 58% rename from docs/source/api/evennia.server.admin.rst rename to docs/source/api/evennia.web.api.root.rst index d87b5fe3d4..17f8111937 100644 --- a/docs/source/api/evennia.server.admin.rst +++ b/docs/source/api/evennia.web.api.root.rst @@ -1,7 +1,7 @@ -evennia.server.admin +evennia.web.api.root =========================== -.. automodule:: evennia.server.admin +.. automodule:: evennia.web.api.root :members: :undoc-members: :show-inheritance: diff --git a/docs/source/api/evennia.web.api.rst b/docs/source/api/evennia.web.api.rst index d4e5e15ead..4dab10c9c5 100644 --- a/docs/source/api/evennia.web.api.rst +++ b/docs/source/api/evennia.web.api.rst @@ -13,6 +13,7 @@ evennia.web.api evennia.web.api.filters evennia.web.api.permissions + evennia.web.api.root evennia.web.api.serializers evennia.web.api.tests evennia.web.api.urls diff --git a/docs/source/api/evennia.web.rst b/docs/source/api/evennia.web.rst index 5360420b87..51163bc707 100644 --- a/docs/source/api/evennia.web.rst +++ b/docs/source/api/evennia.web.rst @@ -17,7 +17,9 @@ evennia.web .. toctree:: :maxdepth: 6 + evennia.web.admin evennia.web.api + evennia.web.templatetags evennia.web.utils evennia.web.webclient evennia.web.website diff --git a/docs/source/api/evennia.web.templatetags.addclass.rst b/docs/source/api/evennia.web.templatetags.addclass.rst new file mode 100644 index 0000000000..120ca1c546 --- /dev/null +++ b/docs/source/api/evennia.web.templatetags.addclass.rst @@ -0,0 +1,7 @@ +evennia.web.templatetags.addclass +======================================== + +.. automodule:: evennia.web.templatetags.addclass + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.templatetags.rst b/docs/source/api/evennia.web.templatetags.rst new file mode 100644 index 0000000000..83d842aa6b --- /dev/null +++ b/docs/source/api/evennia.web.templatetags.rst @@ -0,0 +1,14 @@ +evennia.web.templatetags +================================ + +.. automodule:: evennia.web.templatetags + :members: + :undoc-members: + :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.web.templatetags.addclass diff --git a/docs/source/api/evennia.web.utils.adminsite.rst b/docs/source/api/evennia.web.utils.adminsite.rst new file mode 100644 index 0000000000..ce522ffc5f --- /dev/null +++ b/docs/source/api/evennia.web.utils.adminsite.rst @@ -0,0 +1,7 @@ +evennia.web.utils.adminsite +================================== + +.. automodule:: evennia.web.utils.adminsite + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.utils.rst b/docs/source/api/evennia.web.utils.rst index 96158143ea..22f52fef41 100644 --- a/docs/source/api/evennia.web.utils.rst +++ b/docs/source/api/evennia.web.utils.rst @@ -11,6 +11,7 @@ evennia.web.utils .. toctree:: :maxdepth: 6 + evennia.web.utils.adminsite evennia.web.utils.backends evennia.web.utils.general_context evennia.web.utils.middleware diff --git a/docs/source/api/evennia.web.website.rst b/docs/source/api/evennia.web.website.rst index d64379eddf..f895a71560 100644 --- a/docs/source/api/evennia.web.website.rst +++ b/docs/source/api/evennia.web.website.rst @@ -14,10 +14,9 @@ evennia.web.website evennia.web.website.forms evennia.web.website.tests evennia.web.website.urls - evennia.web.website.views .. toctree:: :maxdepth: 6 - evennia.web.website.templatetags + evennia.web.website.views diff --git a/docs/source/api/evennia.web.website.templatetags.addclass.rst b/docs/source/api/evennia.web.website.templatetags.addclass.rst deleted file mode 100644 index f068d8c653..0000000000 --- a/docs/source/api/evennia.web.website.templatetags.addclass.rst +++ /dev/null @@ -1,7 +0,0 @@ -evennia.web.website.templatetags.addclass -================================================ - -.. automodule:: evennia.web.website.templatetags.addclass - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/evennia.web.website.templatetags.rst b/docs/source/api/evennia.web.website.templatetags.rst deleted file mode 100644 index 466be51e36..0000000000 --- a/docs/source/api/evennia.web.website.templatetags.rst +++ /dev/null @@ -1,14 +0,0 @@ -evennia.web.website.templatetags -======================================== - -.. automodule:: evennia.web.website.templatetags - :members: - :undoc-members: - :show-inheritance: - - - -.. toctree:: - :maxdepth: 6 - - evennia.web.website.templatetags.addclass diff --git a/docs/source/api/evennia.web.website.views.accounts.rst b/docs/source/api/evennia.web.website.views.accounts.rst new file mode 100644 index 0000000000..99a396777a --- /dev/null +++ b/docs/source/api/evennia.web.website.views.accounts.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.accounts +========================================= + +.. automodule:: evennia.web.website.views.accounts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.channels.rst b/docs/source/api/evennia.web.website.views.channels.rst new file mode 100644 index 0000000000..8dcf8b398e --- /dev/null +++ b/docs/source/api/evennia.web.website.views.channels.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.channels +========================================= + +.. automodule:: evennia.web.website.views.channels + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.characters.rst b/docs/source/api/evennia.web.website.views.characters.rst new file mode 100644 index 0000000000..4abe1a82ec --- /dev/null +++ b/docs/source/api/evennia.web.website.views.characters.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.characters +=========================================== + +.. automodule:: evennia.web.website.views.characters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.errors.rst b/docs/source/api/evennia.web.website.views.errors.rst new file mode 100644 index 0000000000..85da064c13 --- /dev/null +++ b/docs/source/api/evennia.web.website.views.errors.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.errors +======================================= + +.. automodule:: evennia.web.website.views.errors + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.help.rst b/docs/source/api/evennia.web.website.views.help.rst new file mode 100644 index 0000000000..0223c48881 --- /dev/null +++ b/docs/source/api/evennia.web.website.views.help.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.help +===================================== + +.. automodule:: evennia.web.website.views.help + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.index.rst b/docs/source/api/evennia.web.website.views.index.rst new file mode 100644 index 0000000000..5b885e7580 --- /dev/null +++ b/docs/source/api/evennia.web.website.views.index.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.index +====================================== + +.. automodule:: evennia.web.website.views.index + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.mixins.rst b/docs/source/api/evennia.web.website.views.mixins.rst new file mode 100644 index 0000000000..5cf685bfb1 --- /dev/null +++ b/docs/source/api/evennia.web.website.views.mixins.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.mixins +======================================= + +.. automodule:: evennia.web.website.views.mixins + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.objects.rst b/docs/source/api/evennia.web.website.views.objects.rst new file mode 100644 index 0000000000..787c006aae --- /dev/null +++ b/docs/source/api/evennia.web.website.views.objects.rst @@ -0,0 +1,7 @@ +evennia.web.website.views.objects +======================================== + +.. automodule:: evennia.web.website.views.objects + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.rst b/docs/source/api/evennia.web.website.views.rst index 367e8c102a..35489078b9 100644 --- a/docs/source/api/evennia.web.website.views.rst +++ b/docs/source/api/evennia.web.website.views.rst @@ -1,7 +1,21 @@ evennia.web.website.views -================================ +================================= .. automodule:: evennia.web.website.views :members: :undoc-members: :show-inheritance: + + + +.. toctree:: + :maxdepth: 6 + + evennia.web.website.views.accounts + evennia.web.website.views.channels + evennia.web.website.views.characters + evennia.web.website.views.errors + evennia.web.website.views.help + evennia.web.website.views.index + evennia.web.website.views.mixins + evennia.web.website.views.objects diff --git a/docs/source/toc.md b/docs/source/toc.md index 21ddd67512..00050cc0c7 100644 --- a/docs/source/toc.md +++ b/docs/source/toc.md @@ -1,5 +1,5 @@ # Toc - +- [API root](api/evennia-api.rst) - [Coding/Coding Introduction](Coding/Coding-Introduction) - [Coding/Coding Overview](Coding/Coding-Overview) - [Coding/Continuous Integration](Coding/Continuous-Integration) diff --git a/evennia/typeclasses/models.py b/evennia/typeclasses/models.py index 440b3bfc55..036ce173e2 100644 --- a/evennia/typeclasses/models.py +++ b/evennia/typeclasses/models.py @@ -182,15 +182,16 @@ class TypedObject(SharedMemoryModel): mechanics for managing connected attributes. The TypedObject has the following properties: - key - main name - name - alias for key - typeclass_path - the path to the decorating typeclass - typeclass - auto-linked typeclass - date_created - time stamp of object creation - permissions - perm strings - dbref - #id of object - db - persistent attribute storage - ndb - non-persistent attribute storage + + - key - main name + - name - alias for key + - typeclass_path - the path to the decorating typeclass + - typeclass - auto-linked typeclass + - date_created - time stamp of object creation + - permissions - perm strings + - dbref - #id of object + - db - persistent attribute storage + - ndb - non-persistent attribute storage """ @@ -937,7 +938,7 @@ class TypedObject(SharedMemoryModel): Examples: :: - Oscar (Character) = '/characters/oscar/1/puppet/' + Oscar (Character) = '/characters/oscar/1/puppet/' For this to work, the developer must have defined a named view somewhere in urls.py that follows the format 'modelname-action', so in this case diff --git a/evennia/utils/evmore.py b/evennia/utils/evmore.py index 999214e34a..a9a8e6d4f5 100644 --- a/evennia/utils/evmore.py +++ b/evennia/utils/evmore.py @@ -454,15 +454,14 @@ class EvMore(object): If overridden, this method must perform the following actions: - read and re-store `self._data` (the incoming data set) if needed for pagination to - work. + work. - set `self._npages` to the total number of pages. Default is 1. - set `self._paginator` to a callable that will take a page number 1...N and return the data to display on that page (not any decorations or next/prev buttons). If only wanting to change the paginator, override `self.paginator` instead. - set `self._page_formatter` to a callable that will receive the page from - `self._paginator` and format it with one element per line. Default is `str`. Or - override `self.page_formatter` - directly instead. + `self._paginator` and format it with one element per line. Default is `str`. Or + override `self.page_formatter` directly instead. By default, helper methods are called that perform these actions depending on supported inputs. diff --git a/evennia/web/urls.py b/evennia/web/urls.py index 5b732012cc..36e54beab2 100644 --- a/evennia/web/urls.py +++ b/evennia/web/urls.py @@ -2,17 +2,17 @@ File that determines what each URL points to. This uses Python regular expressions. This is the starting point when a user enters an URL. - 1. The URL is matched with a regex, tying it to a given view. Note that this central url.py - file includes url.py from all the various web-components found in views/ so the search - space is much larger than what is shown here. - 2. The view (a Python function or class is executed) - 3. The view uses a template (a HTML file which may contain template markers for dynamically - modifying its contents; the locations of such templates are given by - `settings.TEMPLATES[0]['DIRS']`) and which may in turn may include static - assets (CSS, images etc). - 4. The view 'renders' the template into a finished HTML page, replacing all - dynamic content as appropriate. - 5. The HTML page is returned to the user. +1. The URL is matched with a regex, tying it to a given view. Note that this central url.py + file includes url.py from all the various web-components found in views/ so the search + space is much larger than what is shown here. +2. The view (a Python function or class is executed) +3. The view uses a template (a HTML file which may contain template markers for dynamically + modifying its contents; the locations of such templates are given by + `settings.TEMPLATES[0]['DIRS']`) and which may in turn may include static + assets (CSS, images etc). +4. The view 'renders' the template into a finished HTML page, replacing all + dynamic content as appropriate. +5. The HTML page is returned to the user. """