Cleaned up Coding and style guides, improved contribs

This commit is contained in:
Griatch 2022-11-25 19:47:32 +01:00
parent 5e5fe1dcde
commit 00035c15d5
30 changed files with 1135 additions and 1360 deletions

View file

@ -80,7 +80,7 @@ Each contrib contains installation instructions for how to integrate it
with your other code. If you want to tweak the code of a contrib, just
copy its entire folder to your game directory and modify/use it from there.
If you want to contribute yourself, see [here](Contributing)!
If you want to add a contrib, see [the contrib guidelines](Contribs-Guidelines)!
[forum]: https://github.com/evennia/evennia/discussions/categories/community-contribs-snippets
@ -90,7 +90,12 @@ If you want to contribute yourself, see [here](Contributing)!
"""
TOCTREE = """```{{toctree}}
TOCTREE = """
```{{toctree}}
:hidden:
Contribs-Guidelines.md
```
```{{toctree}}
:maxdepth: 1
{listing}

View file

@ -12,9 +12,26 @@ DOCSRCDIR = pathjoin(DOCDIR, "source")
EVENNIADIR = pathjoin(ROOTDIR, "evennia")
def update_code_style():
"""
Plain CODING_STYLE.md copy
"""
sourcefile = pathjoin(ROOTDIR, "CODING_STYLE.md")
targetfile = pathjoin(DOCSRCDIR, "Coding", "Evennia-Code-Style.md")
with open(sourcefile) as fil:
txt = fil.read()
with open(targetfile, "w") as fil:
fil.write(txt)
print(" -- Updated Evennia-Code-Style.md")
def update_changelog():
"""
Plain CHANGELOG copy
Plain CHANGELOG.md copy
"""
@ -77,6 +94,7 @@ def update_dynamic_pages():
"""
update_changelog()
update_default_settings()
update_code_style()
if __name__ == "__main__":