diff --git a/doc/source/contributor/doc_contribute_guide.rst b/doc/source/contributor/doc_contribute_guide.rst index 2abbb808a..d2e27821c 100644 --- a/doc/source/contributor/doc_contribute_guide.rst +++ b/doc/source/contributor/doc_contribute_guide.rst @@ -1486,8 +1486,6 @@ Use the :command:`system help` command for the full list of options. Cross-references **************** -.. begin-xrefs - Cross-reference to arbitrary locations in a document using the ``ref`` role and a named target. Named targets must precede a section heading. For more information on references, see `Internal Hyperlink Targets @@ -1501,6 +1499,8 @@ When using external references, be sure to prefix the URL with either `Internal Hyperlink Targets `_. +.. begin-xrefs-sample-note + .. note:: When providing an example of a URL format, treat the example as code by @@ -1511,7 +1511,7 @@ When using external references, be sure to prefix the URL with either ``https:///`` -.. end-xrefs +.. end-xrefs-sample-note **Input:**