From e09b6b1a2f8890d61edce7abe09ee853caa4ec26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kriszti=C3=A1n=20Szab=C3=B3?= Date: Mon, 29 Apr 2024 20:42:13 +0200 Subject: [PATCH 1/2] doc: fix external link typo in style guide --- docs/docsite/rst/dev_guide/style_guide/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docsite/rst/dev_guide/style_guide/index.rst b/docs/docsite/rst/dev_guide/style_guide/index.rst index cb0a1f10c9f..939b3071076 100644 --- a/docs/docsite/rst/dev_guide/style_guide/index.rst +++ b/docs/docsite/rst/dev_guide/style_guide/index.rst @@ -183,7 +183,7 @@ Long pages, or pages with multiple levels of headings, can also include a local .. note:: - Avoid raw URLs. RST and sphinx allow ::code:`https://my.example.com`, but this is unhelpful for those using screen readers. ``:ref:`` links automatically pick up the heading from the anchor, but for external links, always use the ::code:`link title `_` format. + Avoid raw URLs. RST and sphinx allow ::code:`https://my.example.com`, but this is unhelpful for those using screen readers. ``:ref:`` links automatically pick up the heading from the anchor, but for external links, always use the ::code:`\`link title \`_` format. .. _adding_anchors_rst: From 8c250509cfa7f124dda464f08b0fc5bdd6b75efe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kriszti=C3=A1n=20Szab=C3=B3?= Date: Wed, 1 May 2024 15:48:48 +0200 Subject: [PATCH 2/2] doc: remove extra colons from style guide --- docs/docsite/rst/dev_guide/style_guide/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docsite/rst/dev_guide/style_guide/index.rst b/docs/docsite/rst/dev_guide/style_guide/index.rst index 939b3071076..033b70b6ae4 100644 --- a/docs/docsite/rst/dev_guide/style_guide/index.rst +++ b/docs/docsite/rst/dev_guide/style_guide/index.rst @@ -183,7 +183,7 @@ Long pages, or pages with multiple levels of headings, can also include a local .. note:: - Avoid raw URLs. RST and sphinx allow ::code:`https://my.example.com`, but this is unhelpful for those using screen readers. ``:ref:`` links automatically pick up the heading from the anchor, but for external links, always use the ::code:`\`link title \`_` format. + Avoid raw URLs. RST and sphinx allow :code:`https://my.example.com`, but this is unhelpful for those using screen readers. ``:ref:`` links automatically pick up the heading from the anchor, but for external links, always use the :code:`\`link title \`_` format. .. _adding_anchors_rst: