Update doc strings

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).

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

docs/source/api/evennia.comms.admin.rst

@@ -1,7 +0,0 @@
-evennia.comms.admin 
-==========================
-
-.. automodule:: evennia.comms.admin
-   :members:
-   :undoc-members:
-   :show-inheritance:

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

docs/source/api/evennia.help.admin.rst

@@ -1,7 +0,0 @@
-evennia.help.admin 
-=========================
-
-.. automodule:: evennia.help.admin
-   :members:
-   :undoc-members:
-   :show-inheritance:

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

docs/source/api/evennia.objects.admin.rst

@@ -1,7 +0,0 @@
-evennia.objects.admin 
-============================
-
-.. automodule:: evennia.objects.admin
-   :members:
-   :undoc-members:
-   :show-inheritance:

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

docs/source/api/evennia.scripts.admin.rst

@@ -1,7 +0,0 @@
-evennia.scripts.admin 
-============================
-
-.. automodule:: evennia.scripts.admin
-   :members:
-   :undoc-members:
-   :show-inheritance:

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

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

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

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:

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:

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:

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:

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:

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:

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

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:

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:

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:

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:

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:

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:

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

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

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:

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

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:

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

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

docs/source/api/evennia.web.website.templatetags.addclass.rst

@@ -1,7 +0,0 @@
-evennia.web.website.templatetags.addclass 
-================================================
-
-.. automodule:: evennia.web.website.templatetags.addclass
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/api/evennia.web.website.templatetags.rst

@@ -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

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:

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:

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:

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:

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:

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:

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:

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:

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

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)

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
+    - key - main name
-      typeclass_path - the path to the decorating typeclass
+    - name - alias for key
-      typeclass - auto-linked typeclass
+    - typeclass_path - the path to the decorating typeclass
-      date_created - time stamp of object creation
+    - typeclass - auto-linked typeclass
-      permissions - perm strings
+    - date_created - time stamp of object creation
-      dbref - #id of object
+    - permissions - perm strings
-      db - persistent attribute storage
+    - dbref - #id of object
-      ndb - non-persistent attribute storage
+    - 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

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
+              `self._paginator` and format it with one element per line. Default is `str`. Or
-                override `self.page_formatter`
+              override `self.page_formatter` directly instead.
-              directly instead.
 
             By default, helper methods are called that perform these actions
             depending on supported inputs.

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
+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
+   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.
+   space is much larger than what is shown here.
- 2. The view (a Python function or class is executed)
+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
+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
+   modifying its contents; the locations of such templates are given by
-    `settings.TEMPLATES[0]['DIRS']`) and which may in turn may include static
+   `settings.TEMPLATES[0]['DIRS']`) and which may in turn may include static
-    assets (CSS, images etc).
+   assets (CSS, images etc).
- 4. The view 'renders' the template into a finished HTML page, replacing all
+4. The view 'renders' the template into a finished HTML page, replacing all
- dynamic content as appropriate.
+   dynamic content as appropriate.
- 5. The HTML page is returned to the user.
+5. The HTML page is returned to the user.
 
 """