Customize API look, up sphinx version

This commit is contained in:
Griatch 2020-06-18 23:30:11 +02:00
parent 687c1e91f5
commit ef2324e92d
282 changed files with 2021 additions and 2836 deletions

View file

@ -7,9 +7,9 @@ SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SPHINXMULTIVERSION ?= sphinx-multiversion
SPHINXAPIDOC ?= sphinx-apidoc
SPHINXAPIDOCOPTS = --tocfile evennia-api --module-first --force
SPHINXAPIDOCOPTS = --tocfile evennia-api --module-first --force --separate
SPHINXAPIDOCENV = members,undoc-members,show-inheritance
SPHINXAPIDOCEXCLUDE = */migrations/*
SPHINXAPIDOCEXCLUDE = ../*/migrations/* ../evennia/game_template/*
SOURCEDIR = source
BUILDDIR = build
AUTODOCDIR = $(SOURCEDIR)/api
@ -55,11 +55,21 @@ _multiversion-check-env:
_clean_api_index:
rm source/api/*
# remove supervluous 'module' and 'package' text from api headers
_reformat_apidoc_headers:
for f in source/api/*.rst; do\
perl -pi -e 's/(module|package)$$// if $$. == 1' $$f ;\
done
_autodoc-index:
make _clean_api_index
@EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) SPHINX_APIDOC_OPTIONS=$(SPHINXAPIDOCENV) $(SPHINXAPIDOC) $(SPHINXAPIDOCOPTS) -o $(SOURCEDIR)/api/ $(EVDIR) $(SPHINXAPIDOCEXCLUDE)
make _reformat_apidoc_headers
_multiversion-autodoc-index:
make _clean_api_index
@EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) SPHINX_APIDOC_OPTIONS=$(SPHINXAPIDOCENV) $(SPHINXAPIDOC) $(SPHINXAPIDOCOPTS) -o $(SOURCEDIR)/api/ $(EVDIR) $(SPHINXAPIDOCEXCLUDE)
make _reformat_apidoc_headers
git diff-index --quiet HEAD || git commit -a -m "Updated API autodoc index."
_html-build:

View file

@ -1,7 +1,7 @@
# requirements for building the docs
sphinx==2.4.4
sphinx-multiversion==0.1.1
sphinx==3.1.1
sphinx-multiversion==0.2.3
# recommonmark custom branch with evennia-specific fixes
git+https://github.com/evennia/recommonmark.git@evennia-mods#egg=recommonmark

View file

@ -569,7 +569,7 @@ dd {
}
dt:target, span.highlighted {
background-color: #fbe54e;
background-color: #fffbde;
}
rect.highlighted {
@ -704,7 +704,7 @@ div.literal-block-wrapper div.highlight {
code.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
font-size: 0.9em;
}
code.descclassname {

View file

@ -297,7 +297,7 @@ code {
}
div.viewcode-block:target {
background-color: #f4debf;
background-color: #f4e9d9;
border-top: 1px solid #ac9;
border-bottom: 1px solid #ac9;
}
@ -328,3 +328,49 @@ div.code-block-caption {
.deprecated {
background-color: #fff3f3;
}
/* API-docs custom coloring */
.class {
font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace;
font-size: 0.9em;
background-color: #f5ffff;
padding: 5px;
}
.method {
background-color: #e3ecec;
padding: 5px;
font-size: 1.0em;
}
.sig-param {
font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace;
}
.property {
font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace;
}
dl.class > dd > p {
font-style: italic;
}
dl.method > dd > p {
font-style: italic;
}
code.descname {
font-size: 0.9em;
}
.function {
background-color: #eff;
padding: 5px;
}
.exception {
background-color: #fff9f9;
padding: 5px;
}

View file

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

View file

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

View file

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

View file

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

View file

@ -1,83 +0,0 @@
evennia.accounts.migrations package
===================================
.. automodule:: evennia.accounts.migrations
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
evennia.accounts.migrations.0001\_initial module
------------------------------------------------
.. automodule:: evennia.accounts.migrations.0001_initial
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.migrations.0002\_move\_defaults module
-------------------------------------------------------
.. automodule:: evennia.accounts.migrations.0002_move_defaults
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.migrations.0003\_auto\_20150209\_2234 module
-------------------------------------------------------------
.. automodule:: evennia.accounts.migrations.0003_auto_20150209_2234
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.migrations.0004\_auto\_20150403\_2339 module
-------------------------------------------------------------
.. automodule:: evennia.accounts.migrations.0004_auto_20150403_2339
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.migrations.0005\_auto\_20160905\_0902 module
-------------------------------------------------------------
.. automodule:: evennia.accounts.migrations.0005_auto_20160905_0902
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.migrations.0006\_auto\_20170606\_1731 module
-------------------------------------------------------------
.. automodule:: evennia.accounts.migrations.0006_auto_20170606_1731
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.migrations.0007\_copy\_player\_to\_account module
------------------------------------------------------------------
.. automodule:: evennia.accounts.migrations.0007_copy_player_to_account
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.migrations.0008\_auto\_20190128\_1820 module
-------------------------------------------------------------
.. automodule:: evennia.accounts.migrations.0008_auto_20190128_1820
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.migrations.0009\_auto\_20191025\_0831 module
-------------------------------------------------------------
.. automodule:: evennia.accounts.migrations.0009_auto_20191025_0831
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

@ -1,4 +1,4 @@
evennia.accounts package
evennia.accounts
========================
.. automodule:: evennia.accounts
@ -6,61 +6,15 @@ evennia.accounts package
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
evennia.accounts.migrations
Submodules
----------
evennia.accounts.accounts module
--------------------------------
.. automodule:: evennia.accounts.accounts
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.admin module
-----------------------------
.. automodule:: evennia.accounts.admin
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.bots module
----------------------------
.. automodule:: evennia.accounts.bots
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.manager module
-------------------------------
.. automodule:: evennia.accounts.manager
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.models module
------------------------------
.. automodule:: evennia.accounts.models
:members:
:undoc-members:
:show-inheritance:
evennia.accounts.tests module
-----------------------------
.. automodule:: evennia.accounts.tests
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 4
evennia.accounts.accounts
evennia.accounts.admin
evennia.accounts.bots
evennia.accounts.manager
evennia.accounts.models
evennia.accounts.tests

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -0,0 +1,7 @@
evennia.commands.default.account
=======================================
.. automodule:: evennia.commands.default.account
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

@ -0,0 +1,7 @@
evennia.commands.default.batchprocess
============================================
.. automodule:: evennia.commands.default.batchprocess
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.commands.default.building
========================================
.. automodule:: evennia.commands.default.building
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.commands.default.cmdset\_account
===============================================
.. automodule:: evennia.commands.default.cmdset_account
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.commands.default.cmdset\_character
=================================================
.. automodule:: evennia.commands.default.cmdset_character
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.commands.default.cmdset\_session
===============================================
.. automodule:: evennia.commands.default.cmdset_session
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.commands.default.cmdset\_unloggedin
==================================================
.. automodule:: evennia.commands.default.cmdset_unloggedin
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

@ -0,0 +1,7 @@
evennia.commands.default.general
=======================================
.. automodule:: evennia.commands.default.general
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

@ -0,0 +1,7 @@
evennia.commands.default.muxcommand
==========================================
.. automodule:: evennia.commands.default.muxcommand
:members:
:undoc-members:
:show-inheritance:

View file

@ -1,4 +1,4 @@
evennia.commands.default package
evennia.commands.default
================================
.. automodule:: evennia.commands.default
@ -9,131 +9,22 @@ evennia.commands.default package
Submodules
----------
evennia.commands.default.account module
---------------------------------------
.. automodule:: evennia.commands.default.account
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.admin module
-------------------------------------
.. automodule:: evennia.commands.default.admin
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.batchprocess module
--------------------------------------------
.. automodule:: evennia.commands.default.batchprocess
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.building module
----------------------------------------
.. automodule:: evennia.commands.default.building
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.cmdset\_account module
-----------------------------------------------
.. automodule:: evennia.commands.default.cmdset_account
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.cmdset\_character module
-------------------------------------------------
.. automodule:: evennia.commands.default.cmdset_character
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.cmdset\_session module
-----------------------------------------------
.. automodule:: evennia.commands.default.cmdset_session
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.cmdset\_unloggedin module
--------------------------------------------------
.. automodule:: evennia.commands.default.cmdset_unloggedin
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.comms module
-------------------------------------
.. automodule:: evennia.commands.default.comms
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.general module
---------------------------------------
.. automodule:: evennia.commands.default.general
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.help module
------------------------------------
.. automodule:: evennia.commands.default.help
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.muxcommand module
------------------------------------------
.. automodule:: evennia.commands.default.muxcommand
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.syscommands module
-------------------------------------------
.. automodule:: evennia.commands.default.syscommands
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.system module
--------------------------------------
.. automodule:: evennia.commands.default.system
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.tests module
-------------------------------------
.. automodule:: evennia.commands.default.tests
:members:
:undoc-members:
:show-inheritance:
evennia.commands.default.unloggedin module
------------------------------------------
.. automodule:: evennia.commands.default.unloggedin
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 4
evennia.commands.default.account
evennia.commands.default.admin
evennia.commands.default.batchprocess
evennia.commands.default.building
evennia.commands.default.cmdset_account
evennia.commands.default.cmdset_character
evennia.commands.default.cmdset_session
evennia.commands.default.cmdset_unloggedin
evennia.commands.default.comms
evennia.commands.default.general
evennia.commands.default.help
evennia.commands.default.muxcommand
evennia.commands.default.syscommands
evennia.commands.default.system
evennia.commands.default.tests
evennia.commands.default.unloggedin

View file

@ -0,0 +1,7 @@
evennia.commands.default.syscommands
===========================================
.. automodule:: evennia.commands.default.syscommands
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.commands.default.system
======================================
.. automodule:: evennia.commands.default.system
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.commands.default.tests
=====================================
.. automodule:: evennia.commands.default.tests
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.commands.default.unloggedin
==========================================
.. automodule:: evennia.commands.default.unloggedin
:members:
:undoc-members:
:show-inheritance:

View file

@ -1,4 +1,4 @@
evennia.commands package
evennia.commands
========================
.. automodule:: evennia.commands
@ -10,57 +10,19 @@ Subpackages
-----------
.. toctree::
:maxdepth: 4
evennia.commands.default
Submodules
----------
evennia.commands.cmdhandler module
----------------------------------
.. automodule:: evennia.commands.cmdhandler
:members:
:undoc-members:
:show-inheritance:
evennia.commands.cmdparser module
---------------------------------
.. automodule:: evennia.commands.cmdparser
:members:
:undoc-members:
:show-inheritance:
evennia.commands.cmdset module
------------------------------
.. automodule:: evennia.commands.cmdset
:members:
:undoc-members:
:show-inheritance:
evennia.commands.cmdsethandler module
-------------------------------------
.. automodule:: evennia.commands.cmdsethandler
:members:
:undoc-members:
:show-inheritance:
evennia.commands.command module
-------------------------------
.. automodule:: evennia.commands.command
:members:
:undoc-members:
:show-inheritance:
evennia.commands.tests module
-----------------------------
.. automodule:: evennia.commands.tests
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 4
evennia.commands.cmdhandler
evennia.commands.cmdparser
evennia.commands.cmdset
evennia.commands.cmdsethandler
evennia.commands.command
evennia.commands.tests

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -1,163 +0,0 @@
evennia.comms.migrations package
================================
.. automodule:: evennia.comms.migrations
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
evennia.comms.migrations.0001\_initial module
---------------------------------------------
.. automodule:: evennia.comms.migrations.0001_initial
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0002\_msg\_db\_hide\_from\_objects module
------------------------------------------------------------------
.. automodule:: evennia.comms.migrations.0002_msg_db_hide_from_objects
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0003\_auto\_20140917\_0756 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0003_auto_20140917_0756
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0004\_auto\_20150118\_1631 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0004_auto_20150118_1631
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0005\_auto\_20150223\_1517 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0005_auto_20150223_1517
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0006\_channeldb\_db\_object\_subscriptions module
--------------------------------------------------------------------------
.. automodule:: evennia.comms.migrations.0006_channeldb_db_object_subscriptions
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0007\_msg\_db\_tags module
---------------------------------------------------
.. automodule:: evennia.comms.migrations.0007_msg_db_tags
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0008\_auto\_20160905\_0902 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0008_auto_20160905_0902
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0009\_auto\_20160921\_1731 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0009_auto_20160921_1731
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0010\_auto\_20161206\_1912 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0010_auto_20161206_1912
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0011\_auto\_20170217\_2039 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0011_auto_20170217_2039
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0011\_auto\_20170606\_1731 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0011_auto_20170606_1731
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0012\_merge\_20170617\_2017 module
-----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0012_merge_20170617_2017
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0013\_auto\_20170705\_1726 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0013_auto_20170705_1726
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0014\_auto\_20170705\_1736 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0014_auto_20170705_1736
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0015\_auto\_20170706\_2041 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0015_auto_20170706_2041
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0016\_auto\_20180925\_1735 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0016_auto_20180925_1735
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0017\_auto\_20190128\_1820 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0017_auto_20190128_1820
:members:
:undoc-members:
:show-inheritance:
evennia.comms.migrations.0018\_auto\_20191025\_0831 module
----------------------------------------------------------
.. automodule:: evennia.comms.migrations.0018_auto_20191025_0831
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

@ -1,4 +1,4 @@
evennia.comms package
evennia.comms
=====================
.. automodule:: evennia.comms
@ -6,61 +6,15 @@ evennia.comms package
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
evennia.comms.migrations
Submodules
----------
evennia.comms.admin module
--------------------------
.. automodule:: evennia.comms.admin
:members:
:undoc-members:
:show-inheritance:
evennia.comms.channelhandler module
-----------------------------------
.. automodule:: evennia.comms.channelhandler
:members:
:undoc-members:
:show-inheritance:
evennia.comms.comms module
--------------------------
.. automodule:: evennia.comms.comms
:members:
:undoc-members:
:show-inheritance:
evennia.comms.managers module
-----------------------------
.. automodule:: evennia.comms.managers
:members:
:undoc-members:
:show-inheritance:
evennia.comms.models module
---------------------------
.. automodule:: evennia.comms.models
:members:
:undoc-members:
:show-inheritance:
evennia.comms.tests module
--------------------------
.. automodule:: evennia.comms.tests
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 4
evennia.comms.admin
evennia.comms.channelhandler
evennia.comms.comms
evennia.comms.managers
evennia.comms.models
evennia.comms.tests

View file

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

View file

@ -0,0 +1,7 @@
evennia.contrib.awsstorage.aws\_s3\_cdn
==============================================
.. automodule:: evennia.contrib.awsstorage.aws_s3_cdn
:members:
:undoc-members:
:show-inheritance:

View file

@ -1,4 +1,4 @@
evennia.contrib.awsstorage package
evennia.contrib.awsstorage
==================================
.. automodule:: evennia.contrib.awsstorage
@ -9,19 +9,8 @@ evennia.contrib.awsstorage package
Submodules
----------
evennia.contrib.awsstorage.aws\_s3\_cdn module
----------------------------------------------
.. automodule:: evennia.contrib.awsstorage.aws_s3_cdn
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.awsstorage.tests module
---------------------------------------
.. automodule:: evennia.contrib.awsstorage.tests
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 4
evennia.contrib.awsstorage.aws_s3_cdn
evennia.contrib.awsstorage.tests

View file

@ -0,0 +1,7 @@
evennia.contrib.awsstorage.tests
=======================================
.. automodule:: evennia.contrib.awsstorage.tests
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

@ -0,0 +1,7 @@
evennia.contrib.building\_menu
=====================================
.. automodule:: evennia.contrib.building_menu
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

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

View file

@ -0,0 +1,7 @@
evennia.contrib.color\_markups
=====================================
.. automodule:: evennia.contrib.color_markups
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.custom\_gametime
=======================================
.. automodule:: evennia.contrib.custom_gametime
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

@ -0,0 +1,7 @@
evennia.contrib.email\_login
===================================
.. automodule:: evennia.contrib.email_login
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.extended\_room
=====================================
.. automodule:: evennia.contrib.extended_room
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

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

View file

@ -0,0 +1,7 @@
evennia.contrib.health\_bar
==================================
.. automodule:: evennia.contrib.health_bar
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.ingame\_python.callbackhandler
=====================================================
.. automodule:: evennia.contrib.ingame_python.callbackhandler
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.ingame\_python.commands
==============================================
.. automodule:: evennia.contrib.ingame_python.commands
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.ingame\_python.eventfuncs
================================================
.. automodule:: evennia.contrib.ingame_python.eventfuncs
:members:
:undoc-members:
:show-inheritance:

View file

@ -1,4 +1,4 @@
evennia.contrib.ingame\_python package
evennia.contrib.ingame\_python
======================================
.. automodule:: evennia.contrib.ingame_python
@ -9,59 +9,13 @@ evennia.contrib.ingame\_python package
Submodules
----------
evennia.contrib.ingame\_python.callbackhandler module
-----------------------------------------------------
.. automodule:: evennia.contrib.ingame_python.callbackhandler
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.ingame\_python.commands module
----------------------------------------------
.. automodule:: evennia.contrib.ingame_python.commands
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.ingame\_python.eventfuncs module
------------------------------------------------
.. automodule:: evennia.contrib.ingame_python.eventfuncs
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.ingame\_python.scripts module
---------------------------------------------
.. automodule:: evennia.contrib.ingame_python.scripts
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.ingame\_python.tests module
-------------------------------------------
.. automodule:: evennia.contrib.ingame_python.tests
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.ingame\_python.typeclasses module
-------------------------------------------------
.. automodule:: evennia.contrib.ingame_python.typeclasses
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.ingame\_python.utils module
-------------------------------------------
.. automodule:: evennia.contrib.ingame_python.utils
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 4
evennia.contrib.ingame_python.callbackhandler
evennia.contrib.ingame_python.commands
evennia.contrib.ingame_python.eventfuncs
evennia.contrib.ingame_python.scripts
evennia.contrib.ingame_python.tests
evennia.contrib.ingame_python.typeclasses
evennia.contrib.ingame_python.utils

View file

@ -0,0 +1,7 @@
evennia.contrib.ingame\_python.scripts
=============================================
.. automodule:: evennia.contrib.ingame_python.scripts
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.ingame\_python.tests
===========================================
.. automodule:: evennia.contrib.ingame_python.tests
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.ingame\_python.typeclasses
=================================================
.. automodule:: evennia.contrib.ingame_python.typeclasses
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.ingame\_python.utils
===========================================
.. automodule:: evennia.contrib.ingame_python.utils
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

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

View file

@ -0,0 +1,7 @@
evennia.contrib.menu\_login
==================================
.. automodule:: evennia.contrib.menu_login
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

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

View file

@ -0,0 +1,7 @@
evennia.contrib.random\_string\_generator
================================================
.. automodule:: evennia.contrib.random_string_generator
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

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

View file

@ -1,4 +1,4 @@
evennia.contrib package
evennia.contrib
=======================
.. automodule:: evennia.contrib
@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 4
evennia.contrib.awsstorage
evennia.contrib.ingame_python
@ -21,235 +22,35 @@ Subpackages
Submodules
----------
evennia.contrib.barter module
-----------------------------
.. automodule:: evennia.contrib.barter
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.building\_menu module
-------------------------------------
.. automodule:: evennia.contrib.building_menu
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.chargen module
------------------------------
.. automodule:: evennia.contrib.chargen
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.clothing module
-------------------------------
.. automodule:: evennia.contrib.clothing
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.color\_markups module
-------------------------------------
.. automodule:: evennia.contrib.color_markups
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.custom\_gametime module
---------------------------------------
.. automodule:: evennia.contrib.custom_gametime
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.dice module
---------------------------
.. automodule:: evennia.contrib.dice
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.email\_login module
-----------------------------------
.. automodule:: evennia.contrib.email_login
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.extended\_room module
-------------------------------------
.. automodule:: evennia.contrib.extended_room
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.fieldfill module
--------------------------------
.. automodule:: evennia.contrib.fieldfill
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.gendersub module
--------------------------------
.. automodule:: evennia.contrib.gendersub
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.health\_bar module
----------------------------------
.. automodule:: evennia.contrib.health_bar
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.mail module
---------------------------
.. automodule:: evennia.contrib.mail
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.mapbuilder module
---------------------------------
.. automodule:: evennia.contrib.mapbuilder
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.menu\_login module
----------------------------------
.. automodule:: evennia.contrib.menu_login
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.multidescer module
----------------------------------
.. automodule:: evennia.contrib.multidescer
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.puzzles module
------------------------------
.. automodule:: evennia.contrib.puzzles
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.random\_string\_generator module
------------------------------------------------
.. automodule:: evennia.contrib.random_string_generator
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.rplanguage module
---------------------------------
.. automodule:: evennia.contrib.rplanguage
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.rpsystem module
-------------------------------
.. automodule:: evennia.contrib.rpsystem
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.simpledoor module
---------------------------------
.. automodule:: evennia.contrib.simpledoor
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.slow\_exit module
---------------------------------
.. automodule:: evennia.contrib.slow_exit
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.talking\_npc module
-----------------------------------
.. automodule:: evennia.contrib.talking_npc
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.test\_traits module
-----------------------------------
.. automodule:: evennia.contrib.test_traits
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.tests module
----------------------------
.. automodule:: evennia.contrib.tests
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.traits module
-----------------------------
.. automodule:: evennia.contrib.traits
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.tree\_select module
-----------------------------------
.. automodule:: evennia.contrib.tree_select
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.unixcommand module
----------------------------------
.. automodule:: evennia.contrib.unixcommand
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.wilderness module
---------------------------------
.. automodule:: evennia.contrib.wilderness
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 4
evennia.contrib.barter
evennia.contrib.building_menu
evennia.contrib.chargen
evennia.contrib.clothing
evennia.contrib.color_markups
evennia.contrib.custom_gametime
evennia.contrib.dice
evennia.contrib.email_login
evennia.contrib.extended_room
evennia.contrib.fieldfill
evennia.contrib.gendersub
evennia.contrib.health_bar
evennia.contrib.mail
evennia.contrib.mapbuilder
evennia.contrib.menu_login
evennia.contrib.multidescer
evennia.contrib.puzzles
evennia.contrib.random_string_generator
evennia.contrib.rplanguage
evennia.contrib.rpsystem
evennia.contrib.simpledoor
evennia.contrib.slow_exit
evennia.contrib.talking_npc
evennia.contrib.test_traits
evennia.contrib.tests
evennia.contrib.traits
evennia.contrib.tree_select
evennia.contrib.unixcommand
evennia.contrib.wilderness

View file

@ -0,0 +1,7 @@
evennia.contrib.security.auditing.outputs
================================================
.. automodule:: evennia.contrib.security.auditing.outputs
:members:
:undoc-members:
:show-inheritance:

View file

@ -1,4 +1,4 @@
evennia.contrib.security.auditing package
evennia.contrib.security.auditing
=========================================
.. automodule:: evennia.contrib.security.auditing
@ -9,27 +9,9 @@ evennia.contrib.security.auditing package
Submodules
----------
evennia.contrib.security.auditing.outputs module
------------------------------------------------
.. automodule:: evennia.contrib.security.auditing.outputs
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.security.auditing.server module
-----------------------------------------------
.. automodule:: evennia.contrib.security.auditing.server
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.security.auditing.tests module
----------------------------------------------
.. automodule:: evennia.contrib.security.auditing.tests
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 4
evennia.contrib.security.auditing.outputs
evennia.contrib.security.auditing.server
evennia.contrib.security.auditing.tests

View file

@ -0,0 +1,7 @@
evennia.contrib.security.auditing.server
===============================================
.. automodule:: evennia.contrib.security.auditing.server
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.security.auditing.tests
==============================================
.. automodule:: evennia.contrib.security.auditing.tests
:members:
:undoc-members:
:show-inheritance:

View file

@ -1,4 +1,4 @@
evennia.contrib.security package
evennia.contrib.security
================================
.. automodule:: evennia.contrib.security
@ -10,5 +10,6 @@ Subpackages
-----------
.. toctree::
:maxdepth: 4
evennia.contrib.security.auditing

View file

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

View file

@ -0,0 +1,7 @@
evennia.contrib.slow\_exit
=================================
.. automodule:: evennia.contrib.slow_exit
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.talking\_npc
===================================
.. automodule:: evennia.contrib.talking_npc
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.test\_traits
===================================
.. automodule:: evennia.contrib.test_traits
:members:
:undoc-members:
:show-inheritance:

View file

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

View file

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

View file

@ -0,0 +1,7 @@
evennia.contrib.tree\_select
===================================
.. automodule:: evennia.contrib.tree_select
:members:
:undoc-members:
:show-inheritance:

View file

@ -1,4 +1,4 @@
evennia.contrib.turnbattle package
evennia.contrib.turnbattle
==================================
.. automodule:: evennia.contrib.turnbattle
@ -9,43 +9,11 @@ evennia.contrib.turnbattle package
Submodules
----------
evennia.contrib.turnbattle.tb\_basic module
-------------------------------------------
.. automodule:: evennia.contrib.turnbattle.tb_basic
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.turnbattle.tb\_equip module
-------------------------------------------
.. automodule:: evennia.contrib.turnbattle.tb_equip
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.turnbattle.tb\_items module
-------------------------------------------
.. automodule:: evennia.contrib.turnbattle.tb_items
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.turnbattle.tb\_magic module
-------------------------------------------
.. automodule:: evennia.contrib.turnbattle.tb_magic
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.turnbattle.tb\_range module
-------------------------------------------
.. automodule:: evennia.contrib.turnbattle.tb_range
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 4
evennia.contrib.turnbattle.tb_basic
evennia.contrib.turnbattle.tb_equip
evennia.contrib.turnbattle.tb_items
evennia.contrib.turnbattle.tb_magic
evennia.contrib.turnbattle.tb_range

View file

@ -0,0 +1,7 @@
evennia.contrib.turnbattle.tb\_basic
===========================================
.. automodule:: evennia.contrib.turnbattle.tb_basic
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.turnbattle.tb\_equip
===========================================
.. automodule:: evennia.contrib.turnbattle.tb_equip
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.turnbattle.tb\_items
===========================================
.. automodule:: evennia.contrib.turnbattle.tb_items
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.turnbattle.tb\_magic
===========================================
.. automodule:: evennia.contrib.turnbattle.tb_magic
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.turnbattle.tb\_range
===========================================
.. automodule:: evennia.contrib.turnbattle.tb_range
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.tutorial\_examples.bodyfunctions
=======================================================
.. automodule:: evennia.contrib.tutorial_examples.bodyfunctions
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.tutorial\_examples.cmdset\_red\_button
=============================================================
.. automodule:: evennia.contrib.tutorial_examples.cmdset_red_button
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.tutorial\_examples.example\_batch\_code
==============================================================
.. automodule:: evennia.contrib.tutorial_examples.example_batch_code
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.tutorial\_examples.red\_button
=====================================================
.. automodule:: evennia.contrib.tutorial_examples.red_button
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
evennia.contrib.tutorial\_examples.red\_button\_scripts
==============================================================
.. automodule:: evennia.contrib.tutorial_examples.red_button_scripts
:members:
:undoc-members:
:show-inheritance:

View file

@ -1,4 +1,4 @@
evennia.contrib.tutorial\_examples package
evennia.contrib.tutorial\_examples
==========================================
.. automodule:: evennia.contrib.tutorial_examples
@ -9,51 +9,12 @@ evennia.contrib.tutorial\_examples package
Submodules
----------
evennia.contrib.tutorial\_examples.bodyfunctions module
-------------------------------------------------------
.. automodule:: evennia.contrib.tutorial_examples.bodyfunctions
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.tutorial\_examples.cmdset\_red\_button module
-------------------------------------------------------------
.. automodule:: evennia.contrib.tutorial_examples.cmdset_red_button
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.tutorial\_examples.example\_batch\_code module
--------------------------------------------------------------
.. automodule:: evennia.contrib.tutorial_examples.example_batch_code
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.tutorial\_examples.red\_button module
-----------------------------------------------------
.. automodule:: evennia.contrib.tutorial_examples.red_button
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.tutorial\_examples.red\_button\_scripts module
--------------------------------------------------------------
.. automodule:: evennia.contrib.tutorial_examples.red_button_scripts
:members:
:undoc-members:
:show-inheritance:
evennia.contrib.tutorial\_examples.tests module
-----------------------------------------------
.. automodule:: evennia.contrib.tutorial_examples.tests
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 4
evennia.contrib.tutorial_examples.bodyfunctions
evennia.contrib.tutorial_examples.cmdset_red_button
evennia.contrib.tutorial_examples.example_batch_code
evennia.contrib.tutorial_examples.red_button
evennia.contrib.tutorial_examples.red_button_scripts
evennia.contrib.tutorial_examples.tests

Some files were not shown because too many files have changed in this diff Show more