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

Try custom version of recommonmark

Browse source
This commit is contained in:
Griatch 2020-04-05 21:23:33 +02:00
parent 4e730120ee
commit 4887b2dad9
3 changed files with 15 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/requirements.txt
View file

@ -1,7 +1,9 @@
# requirements for building the docs # requirements for building the docs
sphinx sphinx==2.4.4
sphinx-multiversion sphinx-multiversion==0.1.1
recommonmark
# recommonmark
git+https://github.com/evennia/recommonmark.git@master#egg=recommonmark
# theme # theme

2
docs/source/conf.py
View file

@ -104,6 +104,7 @@ smv_outputdir_format = "versions" + sep + "{config.release}"
github_code_root = "https://github.com/evennia/tree/master/" github_code_root = "https://github.com/evennia/tree/master/"
github_doc_root = "https://github.com/evennia/tree/master/docs/sources/" github_doc_root = "https://github.com/evennia/tree/master/docs/sources/"
def url_resolver(url): def url_resolver(url):
print(f"in url_resolver: {url}") print(f"in url_resolver: {url}")
if url.startswith("github:"): if url.startswith("github:"):
@ -114,6 +115,7 @@ def url_resolver(url):
_NO_AUTODOC = os.environ.get("NOAUTODOC") _NO_AUTODOC = os.environ.get("NOAUTODOC")
def autodoc_skip_member(app, what, name, obj, skip, options): def autodoc_skip_member(app, what, name, obj, skip, options):
if _NO_AUTODOC: if _NO_AUTODOC:
return True return True

10
docs/source/index.md
View file

@ -3,11 +3,17 @@ Evennia documentation master file, created by
# Welcome to Evennia's documentation! # Welcome to Evennia's documentation!
Click [here](../evennia/objects/objects.py) to go to objects.py ... .. Click [here](../../../evennia/objects/objects.py) to go to objects.py ... ..
Another [link](github:objects/objects.py) to click ... Another [link](foo) to click. [Fooheader](./foo#AnotherHeading)
Gitlink [here](https://github.com/evennia/evennia/blob/master/README.md)
## Indices and tables ## Indices and tables
* [foo](foo)
* [genindex](genindex) * [genindex](genindex)
* [modindex](modindex) * [modindex](modindex)
* [search](search) * [search](search)