From 371ea0140d3a5de8cf2e396ba7079db9c3d34dd0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leon=20M=C3=B6ller?= Date: Thu, 20 Jun 2024 00:42:11 +0200 Subject: [PATCH] docs: improve the documentation of the `PyECMA376-2` intersphinx workaround Since `PyECMA376-2` doesn't have a documentation we can link to, we ignore missing reference warnings caused by this problem. The visibility of this workaround is improved by making it a `TODO` instead of a regular comment. Furthermore, it now links to the corresponding issue. --- docs/source/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 149ef4f0f..29faf0ed6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -71,7 +71,8 @@ def on_missing_reference(app, env, node, contnode): path = node["reftarget"].split(".") - # pyecma376_2 doesn't have a documentation we can link to, so suppress missing reference warnings. + # TODO: pyecma376_2 doesn't have a documentation we can link to, so suppress missing reference warnings. + # see: https://github.com/rwth-iat/PyECMA376-2/issues/3 if path[0] == "pyecma376_2": return contnode # lxml uses _Element instead of Element and _ElementTree instead of ElementTree in its documentation,