Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add doc-contribution page, toctree-creation mechanism

Browse source
This commit is contained in:
Griatch 2020-06-14 21:45:37 +02:00
parent c380782d61
commit 31306f5b22
6 changed files with 833 additions and 225 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/pylib/copy_from_wiki.py
View file

@ -15,7 +15,7 @@ We also need to build the toc-tree and should do so automatically for now.
import glob
import re
import datetime
import datetime
_RE_MD_LINK = re.compile(r"\[(?P<txt>[\w -\[\]]+?)\]\((?P<url>.+?)\)", re.I + re.S + re.U)
_RE_REF_LINK = re.compile(r"\[[\w -\[\]]*?\]\(.+?\)", re.I + re.S + re.U)
@ -32,13 +32,13 @@ _INDEX_PREFIX = f"""
# VERSION WARNING
> This is the experimental static v0.9 documentation of Evennia, _automatically_ generated from the
> This is the experimental static v0.9 documentation of Evennia, _automatically_ generated from the
> [evennia wiki](https://github.com/evennia/evennia/wiki/) at {datetime.datetime.now()}.
> There are known conversion issues which will _not_ be addressed in this version - refer to
> There are known conversion issues which will _not_ be addressed in this version - refer to
> the original wiki if you have trouble.
>
> Manual conversion and cleanup will instead happen during development of the upcoming v1.0
> version of this static documentation.
> version of this static documentation.
"""
@ -202,7 +202,6 @@ def _sub_link(match):
return f"[{txt}]({url})"
def create_toctree(files):
with open("../source/toc.md", "w") as fil:
fil.write("# Toc\n")
@ -221,7 +220,7 @@ def convert_links(files, outdir):
for inpath in files:
is_index = False
is_index = False
outfile = inpath.rsplit('/', 1)[-1]
if outfile == "Home.md":
outfile = "index.md"
@ -235,7 +234,7 @@ def convert_links(files, outdir):
text = fil.read()
if is_index:
text = _INDEX_PREFIX + text
text = _INDEX_PREFIX + text
lines = text.split("\n")
lines = (lines[:-11]
+ [" - The [TOC](toc) lists all regular documentation pages.\n\n"]
@ -256,6 +255,6 @@ def convert_links(files, outdir):
fil.write(text)
if __name__ == "__main__":
create_toctree(_INFILES)
convert_links(_INFILES, _OUTDIR)
print("This should not be run on develop files, it would overwrite changes.")
# create_toctree(_INFILES)
# convert_links(_INFILES, _OUTDIR)