From c9e9ce2f54b1aa7dfdf9ebe6b33b7f17b06255f7 Mon Sep 17 00:00:00 2001 From: Griatch Date: Thu, 18 Jun 2020 01:13:02 +0200 Subject: [PATCH] Make auto-relinker's error message clearer --- docs/pylib/create_toctree.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/pylib/create_toctree.py b/docs/pylib/create_toctree.py index fba3018b89..a6c87ad4d4 100644 --- a/docs/pylib/create_toctree.py +++ b/docs/pylib/create_toctree.py @@ -6,6 +6,7 @@ directive somewhere. """ import re +from sphinx.errors import DocumentError from pathlib import Path from os.path import abspath, dirname, join as pathjoin, sep @@ -34,8 +35,10 @@ def create_toctree(): url = url.rsplit(".", 1)[0] fname = fname.rsplit(".", 1)[0] if fname in docref_map: - raise RuntimeError(f"'{url}' and '{docref_map[fname]}': Auto-link correction does not " - "accept doc-files with the same name, even in different folders.") + raise DocumentError( + f" Tried to add '{url}.md' when '{docref_map[fname]}.md' already exists.\n" + " Evennia's auto-link-corrector does not accept doc-files with the same \n" + " name, even in different folders. Rename one.\n") docref_map[fname] = url # normal reference-links [txt](urls)