From 013d2c9287e5eb3cfbef7dffd9d042fdfceaa6ce Mon Sep 17 00:00:00 2001 From: jeanluc Date: Tue, 20 Aug 2024 11:07:14 +0200 Subject: [PATCH] Correct cross-ref hint --- docs/topics/documenting/writing.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/topics/documenting/writing.md b/docs/topics/documenting/writing.md index b4bb20e..933f4b3 100644 --- a/docs/topics/documenting/writing.md +++ b/docs/topics/documenting/writing.md @@ -20,7 +20,8 @@ It's possible to cross-reference specific entities, which can improve the docume Link to a complete module. :::{hint} -Works for all modules that are present in the virtual environment, which includes Salt core ones. +Works for all packages whose docs are registered in the `docs/conf.py` +`intersphinx_mapping`. This specifically includes Salt core by default. ::: :::{tab} MyST @@ -39,7 +40,8 @@ Works for all modules that are present in the virtual environment, which include Link to a specific function in a module. :::{hint} -Works for all modules that are present in the virtual environment, which includes Salt core ones. +Works for all packages whose docs are registered in the `docs/conf.py` +`intersphinx_mapping`. This specifically includes Salt core by default. ::: :::{tab} MyST