Use full URLs for links to issues and pull requests

Author: AA-Turner

sphinx/addnodes.py

@@ -436,7 +436,7 @@ class index(nodes.Invisible, nodes.Inline, nodes.TextElement):
 
     *key* is categorization characters (usually a single character) for
     general index page. For the details of this, please see also:
-    :rst:dir:`glossary` and issue #2320.
+    :rst:dir:`glossary` and https://github.com/sphinx-doc/sphinx/pull/2320.
     """
 
 

sphinx/builders/html/__init__.py

@@ -1193,13 +1193,14 @@ def js_tag(js: _JavaScript | str) -> str:
 
         # sort JS/CSS before rendering HTML
         try:  # NoQA: SIM105
-            # Convert script_files to list to support non-list script_files (refs: #8889)
+            # Convert script_files to list to support non-list script_files
+            # See: https://github.com/sphinx-doc/sphinx/issues/8889
             ctx['script_files'] = sorted(
                 ctx['script_files'], key=lambda js: js.priority
             )
         except AttributeError:
             # Skip sorting if users modifies script_files directly (maybe via `html_context`).
-            # refs: #8885
+            # See: https://github.com/sphinx-doc/sphinx/issues/8885
             #
             # Note: priority sorting feature will not work in this case.
             pass
@@ -1503,7 +1504,8 @@ def setup(app: Sphinx) -> ExtensionMetadata:
         'html_scaled_image_link', True, 'html', types=frozenset({bool})
     )
     app.add_config_value('html_baseurl', '', 'html', types=frozenset({str}))
-    # removal is indefinitely on hold (ref: https://github.com/sphinx-doc/sphinx/issues/10265)
+    # removal is indefinitely on hold
+    # See: https://github.com/sphinx-doc/sphinx/issues/10265
     app.add_config_value(
         'html_codeblock_linenos_style', 'inline', 'html', types=ENUM('table', 'inline')
     )

sphinx/builders/linkcheck.py

@@ -802,7 +802,7 @@ def setup(app: Sphinx) -> ExtensionMetadata:
     app.connect('config-inited', compile_linkcheck_allowed_redirects, priority=800)
 
     # FIXME: Disable URL rewrite handler for github.com temporarily.
-    # ref: https://github.com/sphinx-doc/sphinx/issues/9435
+    # See: https://github.com/sphinx-doc/sphinx/issues/9435
     # app.connect('linkcheck-process-uri', rewrite_github_anchor)
 
     return {

sphinx/cmd/quickstart.py

@@ -76,7 +76,7 @@
 
 if sys.platform == 'win32':
     # On Windows, show questions as bold because of PowerShell's colour scheme
-    # (xref: https://github.com/sphinx-doc/sphinx/issues/5294).
+    # See: https://github.com/sphinx-doc/sphinx/issues/5294
     from sphinx._cli.util.colour import bold as _question_colour
 else:
     from sphinx._cli.util.colour import purple as _question_colour
@@ -163,9 +163,10 @@ def do_prompt(
         else:
             prompt = PROMPT_PREFIX + text + ': '
         if USE_LIBEDIT:
-            # Note: libedit has a problem for combination of ``input()`` and escape
-            # sequence (see #5335).  To avoid the problem, all prompts are not colored
-            # on libedit.
+            # Note: libedit has a problem for combination of ``input()``
+            # and escape sequences.
+            # To avoid the problem, all prompts are not colored on libedit.
+            # See https://github.com/sphinx-doc/sphinx/issues/5335
             pass
         else:
             prompt = _question_colour(prompt)

sphinx/domains/c/__init__.py

@@ -47,7 +47,7 @@
     from sphinx.util.typing import ExtensionMetadata, OptionSpec
 
 # re-export objects for backwards compatibility
-# xref https://github.com/sphinx-doc/sphinx/issues/12295
+# See: https://github.com/sphinx-doc/sphinx/issues/12295
 from sphinx.domains.c._ast import (  # NoQA: F401
     ASTAlignofExpr,
     ASTArray,

sphinx/domains/cpp/__init__.py

@@ -51,7 +51,7 @@
     from sphinx.util.typing import ExtensionMetadata, OptionSpec
 
 # re-export objects for backwards compatibility
-# xref https://github.com/sphinx-doc/sphinx/issues/12295
+# See: https://github.com/sphinx-doc/sphinx/issues/12295
 from sphinx.domains.cpp._ast import (  # NoQA: F401
     ASTAlignofExpr,
     ASTArray,
@@ -317,7 +317,7 @@ def run(self) -> list[Node]:
             env.ref_context['cpp:parent_key'] = root.get_lookup_key()
 
         # The lookup keys assume that no nested scopes exists inside overloaded functions.
-        # (see also #5191)
+        # See: https://github.com/sphinx-doc/sphinx/issues/5191
         # Example:
         # .. cpp:function:: void f(int)
         # .. cpp:function:: void f(double)

sphinx/domains/cpp/_symbol.py

@@ -604,7 +604,8 @@ def _symbol_lookup(
                     return None
             # We have now matched part of a nested name, and need to match more
             # so even if we should match_self before, we definitely shouldn't
-            # even more. (see also issue #2666)
+            # even more.
+            # See: https://github.com/sphinx-doc/sphinx/issues/2666
             match_self = False
             parent_symbol = symbol
 

sphinx/domains/python/__init__.py

@@ -38,7 +38,7 @@
     from sphinx.util.typing import ExtensionMetadata, OptionSpec
 
 # re-export objects for backwards compatibility
-# xref https://github.com/sphinx-doc/sphinx/issues/12295
+# See: https://github.com/sphinx-doc/sphinx/issues/12295
 
 from sphinx.domains.python._annotations import (  # NoQA: F401
     _parse_arglist,  # for sphinx-immaterial

sphinx/environment/adapters/toctree.py

@@ -146,7 +146,8 @@ def _resolve_toctree(
     # </ul>
     #
     # The transformation is made in two passes in order to avoid
-    # interactions between marking and pruning the tree (see bug #1046).
+    # interactions between marking and pruning the tree.
+    # See: https://github.com/sphinx-doc/sphinx/issues/1046
 
     toctree_ancestors = _get_toctree_ancestors(env.toctree_includes, docname)
     included = Matcher(env.config.include_patterns)

sphinx/ext/autodoc/__init__.py

@@ -288,7 +288,8 @@ def process(
 
 
 # This class is used only in ``sphinx.ext.autodoc.directive``,
-# But we define this class here to keep compatibility (see #4538)
+# But we define this class here to keep compatibility
+# See: https://github.com/sphinx-doc/sphinx/issues/4538
 class Options(dict[str, Any]):
     """A dict/attribute hybrid that returns None on nonexisting keys."""
 
@@ -3021,7 +3022,7 @@ def get_doc(self) -> list[list[str]] | None:
         try:
             # Disable `autodoc_inherit_docstring` temporarily to avoid to obtain
             # a docstring from the value which descriptor returns unexpectedly.
-            # ref: https://github.com/sphinx-doc/sphinx/issues/7805
+            # See: https://github.com/sphinx-doc/sphinx/issues/7805
             orig = self.config.autodoc_inherit_docstrings
             self.config.autodoc_inherit_docstrings = False
             return super().get_doc()