From 4887b2dad96856837c48a9721e38b1fc42a551b0 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 5 Apr 2020 21:23:33 +0200 Subject: [PATCH] Try custom version of recommonmark --- docs/requirements.txt | 8 +++++--- docs/source/conf.py | 2 ++ docs/source/index.md | 10 ++++++++-- 3 files changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index d2e8422e65..389b0d72f8 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,9 @@ # requirements for building the docs -sphinx -sphinx-multiversion -recommonmark +sphinx==2.4.4 +sphinx-multiversion==0.1.1 + +# recommonmark +git+https://github.com/evennia/recommonmark.git@master#egg=recommonmark # theme diff --git a/docs/source/conf.py b/docs/source/conf.py index 8a1f04769a..d528614232 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -104,6 +104,7 @@ smv_outputdir_format = "versions" + sep + "{config.release}" github_code_root = "https://github.com/evennia/tree/master/" github_doc_root = "https://github.com/evennia/tree/master/docs/sources/" + def url_resolver(url): print(f"in url_resolver: {url}") if url.startswith("github:"): @@ -114,6 +115,7 @@ def url_resolver(url): _NO_AUTODOC = os.environ.get("NOAUTODOC") + def autodoc_skip_member(app, what, name, obj, skip, options): if _NO_AUTODOC: return True diff --git a/docs/source/index.md b/docs/source/index.md index a807d9c5b8..e20b538ad3 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -3,11 +3,17 @@ Evennia documentation master file, created by # Welcome to Evennia's documentation! -Click [here](../evennia/objects/objects.py) to go to objects.py ... .. -Another [link](github:objects/objects.py) to click ... +Click [here](../../../evennia/objects/objects.py) to go to objects.py ... .. +Another [link](foo) to click. [Fooheader](./foo#AnotherHeading) + + +Gitlink [here](https://github.com/evennia/evennia/blob/master/README.md) ## Indices and tables +* [foo](foo) * [genindex](genindex) * [modindex](modindex) * [search](search) + +