From c09ffbc80ad97e74950bbc777add5ba81d80e1c2 Mon Sep 17 00:00:00 2001 From: Griatch Date: Tue, 13 Oct 2020 23:08:21 +0200 Subject: [PATCH] Handle no-auto-doc builds with no api ref in docs --- docs/pylib/auto_link_remapper.py | 5 +++-- docs/source/conf.py | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/pylib/auto_link_remapper.py b/docs/pylib/auto_link_remapper.py index e817b1ed8e..56b72c5631 100644 --- a/docs/pylib/auto_link_remapper.py +++ b/docs/pylib/auto_link_remapper.py @@ -34,7 +34,7 @@ _USED_REFS = {} _CURRFILE = None -def auto_link_remapper(): +def auto_link_remapper(no_autodoc=False): """ - Auto-Remaps links to fit with the actual document file structure. Requires all doc files to have a unique name. @@ -197,7 +197,8 @@ def auto_link_remapper(): with open(_TOC_FILE, "w") as fil: fil.write("# Toc\n") - fil.write("- [API root](api/evennia-api.rst)") + if not no_autodoc: + fil.write("- [API root](api/evennia-api.rst)") for ref in sorted(toc_map.values()): diff --git a/docs/source/conf.py b/docs/source/conf.py index 601da550b8..f476128d8c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -317,7 +317,8 @@ def setup(app): sys.path.insert(1, os.path.dirname(os.path.dirname(os.path.dirname(__file__)))) from docs.pylib import auto_link_remapper - auto_link_remapper.auto_link_remapper() + _no_autodoc = os.environ.get("NOAUTODOC") + auto_link_remapper.auto_link_remapper(no_autodoc=_no_autodoc) print("Updated source/toc.md file") # custom lunr-based search