Remove tests from api doc

This commit is contained in:
Griatch 2020-07-10 18:04:55 +02:00
parent b1cae35e34
commit 2208a3030c
27 changed files with 298 additions and 320 deletions

View file

@ -17,4 +17,3 @@ Modules
evennia.accounts.bots
evennia.accounts.manager
evennia.accounts.models
evennia.accounts.tests

View file

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

View file

@ -17,7 +17,6 @@ Modules
evennia.commands.cmdset
evennia.commands.cmdsethandler
evennia.commands.command
evennia.commands.tests
Packages/folders
----------------

View file

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

View file

@ -17,4 +17,3 @@ Modules
evennia.comms.comms
evennia.comms.managers
evennia.comms.models
evennia.comms.tests

View file

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

View file

@ -36,7 +36,6 @@ Modules
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

View file

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

View file

@ -14,4 +14,3 @@ Modules
evennia.locks.lockfuncs
evennia.locks.lockhandler
evennia.locks.tests

View file

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

View file

@ -16,4 +16,3 @@ Modules
evennia.objects.manager
evennia.objects.models
evennia.objects.objects
evennia.objects.tests

View file

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

View file

@ -16,4 +16,3 @@ Modules
evennia.prototypes.protfuncs
evennia.prototypes.prototypes
evennia.prototypes.spawner
evennia.prototypes.tests

View file

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

View file

@ -19,5 +19,4 @@ Modules
evennia.scripts.scripthandler
evennia.scripts.scripts
evennia.scripts.taskhandler
evennia.scripts.tests
evennia.scripts.tickerhandler

View file

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

View file

@ -17,4 +17,3 @@ Modules
evennia.typeclasses.managers
evennia.typeclasses.models
evennia.typeclasses.tags
evennia.typeclasses.tests

View file

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

View file

@ -255,11 +255,28 @@ def autodoc_post_process_docstring(app, what, name, obj, options, lines):
return "::\n\n {}".format(
"\n ".join(lne for lne in code.split("\n")))
underline_map = {
1: "-",
2: "=",
3: '^',
4: '"',
}
def _sub_header(match):
# add underline to convert a markdown #header to ReST
groupdict = match.groupdict()
hashes, title = groupdict["hashes"], groupdict["title"]
title = title.strip()
lvl = min(max(1, len(hashes)), 4)
return f"{title}\n" + (underline_map[lvl] * len(title))
doc = "\n".join(lines)
doc = re.sub(r"```python\s*\n+(.*?)```", _sub_codeblock, doc,
flags=re.MULTILINE + re.DOTALL)
doc = re.sub(r"```", "", doc, flags=re.MULTILINE)
doc = re.sub(r"`{1}", "**", doc, flags=re.MULTILINE)
doc = re.sub(r"^(?P<hashes>#{1,2})\s*?(?P<title>.*?)$", _sub_header, doc, flags=re.MULTILINE)
newlines = doc.split("\n")
# we must modify lines in-place
lines[:] = newlines[:]