From 255c448c474ec1b069fd013e132aad9137d7aeb0 Mon Sep 17 00:00:00 2001 From: jd41 Date: Fri, 12 Jun 2020 22:38:55 +0200 Subject: [PATCH 1/2] Distinguish name of extension, name of sample target file and name of sample target section I think the documentation is somewhat clearer if the role, the example file and the example target section within that role aren't all named "hoverxref". I am a Sphinx/RST beginner, currently hunting down why my hoverxref example doesn't work. Having made these changes, I can confirm that having a section "hoverxref_section" within a file "hoverxref_file" should be enough to create a findable target "hoverxref_file:hoverxref_target". It was less clear before. A new user can now easily confirm this by grepping for "hoverxref_target". --- docs/{hoverxref.rst => hoverxref_file.rst} | 6 +++--- docs/index.rst | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) rename docs/{hoverxref.rst => hoverxref_file.rst} (75%) diff --git a/docs/hoverxref.rst b/docs/hoverxref_file.rst similarity index 75% rename from docs/hoverxref.rst rename to docs/hoverxref_file.rst index 2df34a06..7f2c8ecf 100644 --- a/docs/hoverxref.rst +++ b/docs/hoverxref_file.rst @@ -1,8 +1,8 @@ :orphan: -=========== - hoverxref -=========== +================== + hoverxref_section +================== Hi from another completely different page! diff --git a/docs/index.rst b/docs/index.rst index 0688a87b..e5eede74 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,11 +19,11 @@ We currently support two different types of floating windows: Tooltip and Modal. .. code-block:: rst - This will :hoverxref:`show a floating window ` in the linked words. + This will :hoverxref:`show a floating window ` in the linked words. it will be rendered to: - This will :hoverxref:`show a floating window ` in the linked words. + This will :hoverxref:`show a floating window ` in the linked words. .. note:: @@ -36,11 +36,11 @@ We currently support two different types of floating windows: Tooltip and Modal. .. code-block:: rst - This will :hoverxreftooltip:`show a tooltip ` in the linked words. + This will :hoverxreftooltip:`show a tooltip ` in the linked words. it will be rendered to: - This will :hoverxreftooltip:`show a tooltip ` in the linked words. + This will :hoverxreftooltip:`show a tooltip ` in the linked words. .. tab:: Modal style @@ -49,11 +49,11 @@ We currently support two different types of floating windows: Tooltip and Modal. .. code-block:: rst - This will :hoverxrefmodal:`show a modal ` in the linked words. + This will :hoverxrefmodal:`show a modal ` in the linked words. it will be rendered to: - This will :hoverxrefmodal:`show a modal ` in the linked words. + This will :hoverxrefmodal:`show a modal ` in the linked words. .. tip:: From 5503aac7bf08176036d6b8a7096fd27504b2fc0a Mon Sep 17 00:00:00 2001 From: jd41 Date: Fri, 12 Jun 2020 22:50:01 +0200 Subject: [PATCH 2/2] ...and forgot two = signs --- docs/hoverxref_file.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/hoverxref_file.rst b/docs/hoverxref_file.rst index 7f2c8ecf..2ae21949 100644 --- a/docs/hoverxref_file.rst +++ b/docs/hoverxref_file.rst @@ -1,8 +1,8 @@ :orphan: -================== +=================== hoverxref_section -================== +=================== Hi from another completely different page!