mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
Modify package template
This commit is contained in:
Griatch
parent
7fed14d233
commit
b1cae35e34
64 changed files with 307 additions and 446 deletions
|
|
@ -1,5 +1,8 @@
|
|||
# Makefile to control Evennia documentation building.
|
||||
# Most common commands are `make help`, `make quick` and `make local`.
|
||||
SOURCEDIR = source
|
||||
BUILDDIR = build
|
||||
AUTODOCDIR = $(SOURCEDIR)/api
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
|
|
@ -7,12 +10,9 @@ SPHINXOPTS ?=
|
|||
SPHINXBUILD ?= sphinx-build
|
||||
SPHINXMULTIVERSION ?= sphinx-multiversion
|
||||
SPHINXAPIDOC ?= sphinx-apidoc
|
||||
SPHINXAPIDOCOPTS = --tocfile evennia-api --module-first --force --separate
|
||||
SPHINXAPIDOCOPTS = --tocfile evennia-api --module-first --force -d 6 --separate --templatedir=$(SOURCEDIR)/_templates/
|
||||
SPHINXAPIDOCENV = members,undoc-members,show-inheritance
|
||||
SPHINXAPIDOCEXCLUDE = ../*/migrations/* ../evennia/game_template/*
|
||||
SOURCEDIR = source
|
||||
BUILDDIR = build
|
||||
AUTODOCDIR = $(SOURCEDIR)/api
|
||||
SPHINXAPIDOCEXCLUDE = ../*/migrations/* ../evennia/game_template/* ../*/*/tests/*
|
||||
|
||||
EVDIR ?= $(realpath ../evennia)
|
||||
EVGAMEDIR ?= $(realpath ../../gamedir)
|
||||
|
|
|
|||
54
docs/source/_templates/package.rst_t
Normal file
54
docs/source/_templates/package.rst_t
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
{%- macro automodule(modname, options) -%}
|
||||
.. automodule:: {{ modname }}
|
||||
{%- for option in options %}
|
||||
:{{ option }}:
|
||||
{%- endfor %}
|
||||
{%- endmacro %}
|
||||
|
||||
{%- macro toctree(docnames) -%}
|
||||
.. toctree::
|
||||
:maxdepth: {{ maxdepth }}
|
||||
{% for docname in docnames %}
|
||||
{{ docname }}
|
||||
{%- endfor %}
|
||||
{%- endmacro %}
|
||||
|
||||
{%- if is_namespace %}
|
||||
{{- [pkgname, "namespace"] | join(" ") | e | heading }}
|
||||
{% else %}
|
||||
{{- [pkgname, "package"] | join(" ") | e | heading }}
|
||||
{% endif %}
|
||||
|
||||
{%- if modulefirst and not is_namespace %}
|
||||
{{ automodule(pkgname, automodule_options) }}
|
||||
{% endif %}
|
||||
|
||||
{%- if not modulefirst and not is_namespace %}
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
{{ automodule(pkgname, automodule_options) }}
|
||||
{% endif %}
|
||||
|
||||
{%- if submodules %}
|
||||
Modules
|
||||
-------
|
||||
{% if separatemodules %}
|
||||
{{ toctree(submodules) }}
|
||||
{%- else %}
|
||||
{%- for submodule in submodules %}
|
||||
{% if show_headings %}
|
||||
{{- [submodule, "module"] | join(" ") | e | heading(2) }}
|
||||
{% endif %}
|
||||
{{ automodule(submodule, automodule_options) }}
|
||||
{% endfor %}
|
||||
{%- endif %}
|
||||
{% endif %}
|
||||
|
||||
|
||||
{%- if subpackages %}
|
||||
Packages/folders
|
||||
----------------
|
||||
|
||||
{{ toctree(subpackages) }}
|
||||
{% endif %}
|
||||
|
|
@ -2,6 +2,6 @@ evennia
|
|||
=======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.accounts
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.accounts.accounts
|
||||
evennia.accounts.admin
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.commands.default
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.commands.default.account
|
||||
evennia.commands.default.admin
|
||||
|
|
|
|||
|
|
@ -6,19 +6,11 @@ evennia.commands
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
evennia.commands.default
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.commands.cmdhandler
|
||||
evennia.commands.cmdparser
|
||||
|
|
@ -26,3 +18,11 @@ Submodules
|
|||
evennia.commands.cmdsethandler
|
||||
evennia.commands.command
|
||||
evennia.commands.tests
|
||||
|
||||
Packages/folders
|
||||
----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.commands.default
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.comms
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.comms.admin
|
||||
evennia.comms.channelhandler
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.contrib.awsstorage
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.contrib.awsstorage.aws_s3_cdn
|
||||
evennia.contrib.awsstorage.tests
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.contrib.ingame\_python
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.contrib.ingame_python.callbackhandler
|
||||
evennia.contrib.ingame_python.commands
|
||||
|
|
|
|||
|
|
@ -6,24 +6,11 @@ evennia.contrib
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
evennia.contrib.awsstorage
|
||||
evennia.contrib.ingame_python
|
||||
evennia.contrib.security
|
||||
evennia.contrib.turnbattle
|
||||
evennia.contrib.tutorial_examples
|
||||
evennia.contrib.tutorial_world
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.contrib.barter
|
||||
evennia.contrib.building_menu
|
||||
|
|
@ -54,3 +41,16 @@ Submodules
|
|||
evennia.contrib.tree_select
|
||||
evennia.contrib.unixcommand
|
||||
evennia.contrib.wilderness
|
||||
|
||||
Packages/folders
|
||||
----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.contrib.awsstorage
|
||||
evennia.contrib.ingame_python
|
||||
evennia.contrib.security
|
||||
evennia.contrib.turnbattle
|
||||
evennia.contrib.tutorial_examples
|
||||
evennia.contrib.tutorial_world
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.contrib.security.auditing
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.contrib.security.auditing.outputs
|
||||
evennia.contrib.security.auditing.server
|
||||
|
|
|
|||
|
|
@ -6,10 +6,10 @@ evennia.contrib.security
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
Packages/folders
|
||||
----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.contrib.security.auditing
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.contrib.turnbattle
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.contrib.turnbattle.tb_basic
|
||||
evennia.contrib.turnbattle.tb_equip
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.contrib.tutorial\_examples
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.contrib.tutorial_examples.bodyfunctions
|
||||
evennia.contrib.tutorial_examples.cmdset_red_button
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.contrib.tutorial\_world
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.contrib.tutorial_world.mob
|
||||
evennia.contrib.tutorial_world.objects
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.help
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.help.admin
|
||||
evennia.help.manager
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.locks
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.locks.lockfuncs
|
||||
evennia.locks.lockhandler
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.objects
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.objects.admin
|
||||
evennia.objects.manager
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.prototypes
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.prototypes.menus
|
||||
evennia.prototypes.protfuncs
|
||||
|
|
|
|||
|
|
@ -6,11 +6,19 @@ evennia
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.settings_default
|
||||
|
||||
Packages/folders
|
||||
----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.accounts
|
||||
evennia.commands
|
||||
|
|
@ -25,11 +33,3 @@ Subpackages
|
|||
evennia.typeclasses
|
||||
evennia.utils
|
||||
evennia.web
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
evennia.settings_default
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.scripts
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.scripts.admin
|
||||
evennia.scripts.manager
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.server.game\_index\_client
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.server.game_index_client.client
|
||||
evennia.server.game_index_client.service
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.server.portal
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.server.portal.amp
|
||||
evennia.server.portal.amp_server
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.server.profiling
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.server.profiling.dummyrunner
|
||||
evennia.server.profiling.dummyrunner_settings
|
||||
|
|
|
|||
|
|
@ -6,22 +6,11 @@ evennia.server
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
evennia.server.game_index_client
|
||||
evennia.server.portal
|
||||
evennia.server.profiling
|
||||
evennia.server.tests
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.server.admin
|
||||
evennia.server.amp_client
|
||||
|
|
@ -40,3 +29,13 @@ Submodules
|
|||
evennia.server.throttle
|
||||
evennia.server.validators
|
||||
evennia.server.webserver
|
||||
|
||||
Packages/folders
|
||||
----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.server.game_index_client
|
||||
evennia.server.portal
|
||||
evennia.server.profiling
|
||||
|
|
|
|||
|
|
@ -1,20 +0,0 @@
|
|||
evennia.server.tests
|
||||
============================
|
||||
|
||||
.. automodule:: evennia.server.tests
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
evennia.server.tests.test_amp_connection
|
||||
evennia.server.tests.test_initial_setup
|
||||
evennia.server.tests.test_launcher
|
||||
evennia.server.tests.test_misc
|
||||
evennia.server.tests.test_server
|
||||
evennia.server.tests.testrunner
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.server.tests.test\_amp\_connection
|
||||
=================================================
|
||||
|
||||
.. automodule:: evennia.server.tests.test_amp_connection
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.server.tests.test\_initial\_setup
|
||||
================================================
|
||||
|
||||
.. automodule:: evennia.server.tests.test_initial_setup
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.server.tests.test\_launcher
|
||||
==========================================
|
||||
|
||||
.. automodule:: evennia.server.tests.test_launcher
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.server.tests.test\_misc
|
||||
======================================
|
||||
|
||||
.. automodule:: evennia.server.tests.test_misc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.server.tests.test\_server
|
||||
========================================
|
||||
|
||||
.. automodule:: evennia.server.tests.test_server
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.server.tests.testrunner
|
||||
======================================
|
||||
|
||||
.. automodule:: evennia.server.tests.testrunner
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -6,11 +6,11 @@ evennia.typeclasses
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.typeclasses.admin
|
||||
evennia.typeclasses.attributes
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.utils.idmapper
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.utils.idmapper.manager
|
||||
evennia.utils.idmapper.models
|
||||
|
|
|
|||
|
|
@ -6,20 +6,11 @@ evennia.utils
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
evennia.utils.idmapper
|
||||
evennia.utils.tests
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.utils.ansi
|
||||
evennia.utils.batchprocessors
|
||||
|
|
@ -42,3 +33,11 @@ Submodules
|
|||
evennia.utils.text2html
|
||||
evennia.utils.utils
|
||||
evennia.utils.validatorfuncs
|
||||
|
||||
Packages/folders
|
||||
----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.utils.idmapper
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.data.evform\_example
|
||||
===============================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.data.evform_example
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.data.prototypes\_example
|
||||
===================================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.data.prototypes_example
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
evennia.utils.tests.data
|
||||
================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.data
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
evennia.utils.tests.data.evform_example
|
||||
evennia.utils.tests.data.prototypes_example
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
evennia.utils.tests
|
||||
===========================
|
||||
|
||||
.. automodule:: evennia.utils.tests
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
evennia.utils.tests.data
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
evennia.utils.tests.test_ansi
|
||||
evennia.utils.tests.test_batchprocessors
|
||||
evennia.utils.tests.test_create_functions
|
||||
evennia.utils.tests.test_eveditor
|
||||
evennia.utils.tests.test_evform
|
||||
evennia.utils.tests.test_evmenu
|
||||
evennia.utils.tests.test_gametime
|
||||
evennia.utils.tests.test_tagparsing
|
||||
evennia.utils.tests.test_text2html
|
||||
evennia.utils.tests.test_utils
|
||||
evennia.utils.tests.test_validatorfuncs
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.test\_ansi
|
||||
=====================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.test_ansi
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.test\_batchprocessors
|
||||
================================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.test_batchprocessors
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.test\_create\_functions
|
||||
==================================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.test_create_functions
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.test\_eveditor
|
||||
=========================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.test_eveditor
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.test\_evform
|
||||
=======================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.test_evform
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.test\_evmenu
|
||||
=======================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.test_evmenu
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.test\_gametime
|
||||
=========================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.test_gametime
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.test\_tagparsing
|
||||
===========================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.test_tagparsing
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.test\_text2html
|
||||
==========================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.test_text2html
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.test\_utils
|
||||
======================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.test_utils
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
evennia.utils.tests.test\_validatorfuncs
|
||||
===============================================
|
||||
|
||||
.. automodule:: evennia.utils.tests.test_validatorfuncs
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -6,11 +6,11 @@ evennia.web.api
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.web.api.filters
|
||||
evennia.web.api.permissions
|
||||
|
|
|
|||
|
|
@ -6,21 +6,21 @@ evennia.web
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.web.urls
|
||||
|
||||
Packages/folders
|
||||
----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.web.api
|
||||
evennia.web.utils
|
||||
evennia.web.webclient
|
||||
evennia.web.website
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
evennia.web.urls
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.web.utils
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.web.utils.backends
|
||||
evennia.web.utils.general_context
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ evennia.web.webclient
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.web.webclient.urls
|
||||
evennia.web.webclient.views
|
||||
|
|
|
|||
|
|
@ -6,21 +6,21 @@ evennia.web.website
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
evennia.web.website.templatetags
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.web.website.forms
|
||||
evennia.web.website.tests
|
||||
evennia.web.website.urls
|
||||
evennia.web.website.views
|
||||
|
||||
Packages/folders
|
||||
----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.web.website.templatetags
|
||||
|
|
|
|||
|
|
@ -6,10 +6,10 @@ evennia.web.website.templatetags
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
Modules
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 6
|
||||
|
||||
evennia.web.website.templatetags.addclass
|
||||
|
|
|
|||
|
|
@ -211,7 +211,7 @@ if not _no_autodoc:
|
|||
if _no_autodoc:
|
||||
exclude_patterns = ["api/*"]
|
||||
else:
|
||||
exclude_patterns = ["api/*migrations.rst", "api/*tests.rst"]
|
||||
exclude_patterns = ["api/*migrations.rst"]
|
||||
|
||||
autodoc_default_options = {
|
||||
"members": True,
|
||||
|
|
@ -219,6 +219,7 @@ autodoc_default_options = {
|
|||
"show-inheritance": True,
|
||||
"special-members": "__init__",
|
||||
"enable_eval_rst": True,
|
||||
# "inherited_members": True
|
||||
}
|
||||
|
||||
autodoc_member_order = "bysource"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue