Skip to content

Commit

Permalink
docs: improve the documentation of the PyECMA376-2 intersphinx work…
Browse files Browse the repository at this point in the history
…around

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.
  • Loading branch information
jkhsjdhjs committed Jun 19, 2024
1 parent 67432b5 commit 371ea01
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 371ea01

Please sign in to comment.