mirror of
https://github.com/evennia/evennia.git
synced 2026-03-28 18:47:16 +01:00
Update doc strings
This commit is contained in:
parent
f73eec1a34
commit
c7fb61de0f
47 changed files with 224 additions and 92 deletions
|
|
@ -12,7 +12,6 @@ evennia.accounts
|
|||
:maxdepth: 6
|
||||
|
||||
evennia.accounts.accounts
|
||||
evennia.accounts.admin
|
||||
evennia.accounts.bots
|
||||
evennia.accounts.manager
|
||||
evennia.accounts.models
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.comms.admin
|
||||
==========================
|
||||
|
||||
.. automodule:: evennia.comms.admin
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -11,7 +11,6 @@ evennia.comms
|
|||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.comms.admin
|
||||
evennia.comms.comms
|
||||
evennia.comms.managers
|
||||
evennia.comms.models
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.help.admin
|
||||
=========================
|
||||
|
||||
.. automodule:: evennia.help.admin
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -11,7 +11,6 @@ evennia.help
|
|||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.help.admin
|
||||
evennia.help.filehelp
|
||||
evennia.help.manager
|
||||
evennia.help.models
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.objects.admin
|
||||
============================
|
||||
|
||||
.. automodule:: evennia.objects.admin
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -11,7 +11,6 @@ evennia.objects
|
|||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.objects.admin
|
||||
evennia.objects.manager
|
||||
evennia.objects.models
|
||||
evennia.objects.objects
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.scripts.admin
|
||||
============================
|
||||
|
||||
.. automodule:: evennia.scripts.admin
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -11,7 +11,6 @@ evennia.scripts
|
|||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.scripts.admin
|
||||
evennia.scripts.manager
|
||||
evennia.scripts.models
|
||||
evennia.scripts.monitorhandler
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ evennia.server
|
|||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.server.admin
|
||||
evennia.server.amp_client
|
||||
evennia.server.connection_wizard
|
||||
evennia.server.deprecations
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ evennia.typeclasses
|
|||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.typeclasses.admin
|
||||
evennia.typeclasses.attributes
|
||||
evennia.typeclasses.managers
|
||||
evennia.typeclasses.models
|
||||
|
|
|
|||
7
docs/source/api/evennia.web.admin.accounts.rst
Normal file
7
docs/source/api/evennia.web.admin.accounts.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.admin.accounts
|
||||
=================================
|
||||
|
||||
.. automodule:: evennia.web.admin.accounts
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.admin.attributes.rst
Normal file
7
docs/source/api/evennia.web.admin.attributes.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.admin.attributes
|
||||
===================================
|
||||
|
||||
.. automodule:: evennia.web.admin.attributes
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.admin.comms.rst
Normal file
7
docs/source/api/evennia.web.admin.comms.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.admin.comms
|
||||
==============================
|
||||
|
||||
.. automodule:: evennia.web.admin.comms
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.admin.frontpage.rst
Normal file
7
docs/source/api/evennia.web.admin.frontpage.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.admin.frontpage
|
||||
==================================
|
||||
|
||||
.. automodule:: evennia.web.admin.frontpage
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -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:
|
||||
|
|
@ -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:
|
||||
24
docs/source/api/evennia.web.admin.rst
Normal file
24
docs/source/api/evennia.web.admin.rst
Normal file
|
|
@ -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
|
||||
7
docs/source/api/evennia.web.admin.scripts.rst
Normal file
7
docs/source/api/evennia.web.admin.scripts.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.admin.scripts
|
||||
================================
|
||||
|
||||
.. automodule:: evennia.web.admin.scripts
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.admin.server.rst
Normal file
7
docs/source/api/evennia.web.admin.server.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.admin.server
|
||||
===============================
|
||||
|
||||
.. automodule:: evennia.web.admin.server
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.admin.tags.rst
Normal file
7
docs/source/api/evennia.web.admin.tags.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.admin.tags
|
||||
=============================
|
||||
|
||||
.. automodule:: evennia.web.admin.tags
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.admin.urls.rst
Normal file
7
docs/source/api/evennia.web.admin.urls.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.admin.urls
|
||||
=============================
|
||||
|
||||
.. automodule:: evennia.web.admin.urls
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.admin.utils.rst
Normal file
7
docs/source/api/evennia.web.admin.utils.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.admin.utils
|
||||
==============================
|
||||
|
||||
.. automodule:: evennia.web.admin.utils
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -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:
|
||||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
7
docs/source/api/evennia.web.templatetags.addclass.rst
Normal file
7
docs/source/api/evennia.web.templatetags.addclass.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.templatetags.addclass
|
||||
========================================
|
||||
|
||||
.. automodule:: evennia.web.templatetags.addclass
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
14
docs/source/api/evennia.web.templatetags.rst
Normal file
14
docs/source/api/evennia.web.templatetags.rst
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
evennia.web.templatetags
|
||||
================================
|
||||
|
||||
.. automodule:: evennia.web.templatetags
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.web.templatetags.addclass
|
||||
7
docs/source/api/evennia.web.utils.adminsite.rst
Normal file
7
docs/source/api/evennia.web.utils.adminsite.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.utils.adminsite
|
||||
==================================
|
||||
|
||||
.. automodule:: evennia.web.utils.adminsite
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.web.website.templatetags.addclass
|
||||
================================================
|
||||
|
||||
.. automodule:: evennia.web.website.templatetags.addclass
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -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
|
||||
7
docs/source/api/evennia.web.website.views.accounts.rst
Normal file
7
docs/source/api/evennia.web.website.views.accounts.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.website.views.accounts
|
||||
=========================================
|
||||
|
||||
.. automodule:: evennia.web.website.views.accounts
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.website.views.channels.rst
Normal file
7
docs/source/api/evennia.web.website.views.channels.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.website.views.channels
|
||||
=========================================
|
||||
|
||||
.. automodule:: evennia.web.website.views.channels
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.website.views.characters.rst
Normal file
7
docs/source/api/evennia.web.website.views.characters.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.website.views.characters
|
||||
===========================================
|
||||
|
||||
.. automodule:: evennia.web.website.views.characters
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.website.views.errors.rst
Normal file
7
docs/source/api/evennia.web.website.views.errors.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.website.views.errors
|
||||
=======================================
|
||||
|
||||
.. automodule:: evennia.web.website.views.errors
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.website.views.help.rst
Normal file
7
docs/source/api/evennia.web.website.views.help.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.website.views.help
|
||||
=====================================
|
||||
|
||||
.. automodule:: evennia.web.website.views.help
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.website.views.index.rst
Normal file
7
docs/source/api/evennia.web.website.views.index.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.website.views.index
|
||||
======================================
|
||||
|
||||
.. automodule:: evennia.web.website.views.index
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.website.views.mixins.rst
Normal file
7
docs/source/api/evennia.web.website.views.mixins.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.website.views.mixins
|
||||
=======================================
|
||||
|
||||
.. automodule:: evennia.web.website.views.mixins
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/api/evennia.web.website.views.objects.rst
Normal file
7
docs/source/api/evennia.web.website.views.objects.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
evennia.web.website.views.objects
|
||||
========================================
|
||||
|
||||
.. automodule:: evennia.web.website.views.objects
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue