sphinx-codeautolink 0.16.2__tar.gz → 0.17.0__tar.gz

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/MANIFEST.in

@@ -1,6 +1,7 @@
 graft docs
 prune docs/build
 graft requirements
+graft src
 graft tests
 include contributing.rst readme_pypi.rst tox.ini
 global-exclude *.py[cod] __pycache__ *.so

{sphinx_codeautolink-0.16.2/src/sphinx_codeautolink.egg-info → sphinx_codeautolink-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: sphinx-codeautolink
-Version: 0.16.2
+Version: 0.17.0
 Summary: Automatic links from code examples to reference documentation.
 Author-email: Felix Hildén <felix.hilden@gmail.com>
 Maintainer-email: Felix Hildén <felix.hilden@gmail.com>
@@ -70,7 +70,6 @@ sphinx-codeautolink can be installed from the following sources:
 .. code:: sh
 
     $ pip install sphinx-codeautolink
-    # or, alternatively:
     $ conda install -c conda-forge sphinx-codeautolink
 
 Note that the library is in early development, so version pinning is advised.
@@ -85,9 +84,9 @@ Note that the extension name uses an underscore rather than a hyphen.
    ]
 
 That's it! Now your code examples are linked.
-For ways of concatenating multiple examples
-and setting default import statements among other things,
-have a look at the online documentation.
+For ways of concatenating examples, setting default import statements,
+or customising link style among other things,
+see the `online documentation <https://sphinx-codeautolink.rtfd.org>`_.
 
 .. |pyversions| image:: https://img.shields.io/pypi/pyversions/sphinx-codeautolink
    :alt: Python versions

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/docs/src/about.rst

@@ -18,7 +18,7 @@ Caveats
 -------
 - **Only works with HTML documentation**, disabled otherwise. If the extension
   is off, it silently removes directives that would produce output.
-- **Only processes literal blocks, not inline code**. Sphinx has great tools
+- **Only processes blocks, not inline code**. Sphinx has great tools
   for linking definitions inline, and longer code should be in a block anyway.
 - **Doesn't run example code**. Therefore all possible resolvable types are not
   found, and the runtime correctness of code cannot be validated.

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/docs/src/conf.py

@@ -56,6 +56,9 @@ plot_formats = [("png", 90)]
 plot_html_show_formats = False
 plot_html_show_source_link = False
 
+html_static_path = ["static"]
+html_css_files = ["custom.css"]
+
 
 def setup(app) -> None:
     app.add_object_type(

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/docs/src/examples.rst

@@ -21,10 +21,16 @@ be analysed and linked to known reference documentation entries.
 
 Different import styles are supported, along with all Python syntax.
 Star imports might be particularly handy in code examples.
-`Doctest <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
-#doctest-blocks>`_ and console blocks using :code:`.. code:: pycon` work too.
-Including code via :rst:dir:`literalinclude` requires using a
-:code:`:language: py` parameter.
+
+A number of other types of blocks are also supported
+along with standard Sphinx configuration, like:
+
+- Literal blocks, the ``.. highlight::`` directive
+  and ``highlight_language`` configuration
+- `Doctest blocks <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#doctest-blocks>`_
+- Console blocks using :code:`.. code:: pycon`
+- Including code via :rst:dir:`literalinclude`, but requires using one of the
+  `Python Lexers <https://pygments.org/docs/lexers/#pygments.lexers.python.PythonLexer>`_
 
 .. code:: pycon
 
@@ -39,7 +45,9 @@ particularly in the reference documentation itself:
 
 .. autolink-examples:: lib.Knight
 
-Such a table is generated with :rst:dir:`autolink-examples`::
+Such a table is generated with :rst:dir:`autolink-examples`:
+
+.. code-block:: rst
 
    .. autolink-examples:: lib.Knight
 
@@ -54,14 +62,18 @@ The import can be hidden instead.
 
   lib.Knight().taunt()
 
-The previous block is produced with :rst:dir:`autolink-preface`::
+The previous block is produced with :rst:dir:`autolink-preface`:
+
+.. code-block:: rst
 
    .. autolink-preface:: import lib
    .. code:: python
 
         lib.Knight().taunt()
 
-A multiline preface can be written in the content portion of the directive::
+A multiline preface can be written in the content portion of the directive:
+
+.. code-block:: rst
 
    .. autolink-preface::
 
@@ -90,7 +102,9 @@ the previous left off.
        print(knight.taunt())
        knight.scratch()
 
-This was achieved with :rst:dir:`autolink-concat`::
+This was achieved with :rst:dir:`autolink-concat`:
+
+.. code-block:: rst
 
    .. autolink-concat:: section
    .. code:: python
@@ -118,7 +132,9 @@ and preventing it from being included in further sources with concatenation.
    import lib
    lib.Knight()
 
-Which is done via :rst:dir:`autolink-skip`::
+Which is done via :rst:dir:`autolink-skip`:
+
+.. code-block:: rst
 
    .. autolink-skip::
    .. code:: python
@@ -190,7 +206,9 @@ Reference tables across intersphinx work too:
 It seems that the reference type information is more important
 for Sphinx when dealing with external modules,
 likely because the references cannot be resolved dynamically.
-Please specify a ``type`` in :rst:dir:`autolink-examples`::
+Please specify a ``type`` in :rst:dir:`autolink-examples`:
+
+.. code-block:: rst
 
    .. autolink-examples:: numpy.linspace
       :type: func
@@ -294,12 +312,12 @@ For example, a transformer could be implemented as follows:
 Sometimes links with third-party code blocks are broken.
 See :ref:`about` for a potential solution.
 
+.. _examples-css:
+
 Custom link styles
 ------------------
 If you want a specific style to be applied to code block links,
 you may add your own CSS file to the Sphinx build.
-All code block links use the ``sphinx-codeautolink-a`` class.
-For example, you can add dotted lines to all links and change the hover colour:
 
 .. code:: python
 
@@ -307,12 +325,17 @@ For example, you can add dotted lines to all links and change the hover colour:
    html_static_path = ['static']
    html_css_files = ['custom.css']
 
+To include only in specific documents, see the ``html-page-context`` event
+and the :meth:`Sphinx.add_css_file` function.
+For example, you can add similar underlines as this documentation
+and change the hover colour:
+
 .. code:: css
 
    /* static/custom.css */
    .sphinx-codeautolink-a{
-       border-bottom-color: rgb(0, 0, 0);
-       border-bottom-style: dotted;
+       border-bottom-color: #ccc;
+       border-bottom-style: solid;
        border-bottom-width: 1px;
    }
    .sphinx-codeautolink-a:hover{

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/docs/src/index.rst

@@ -5,7 +5,7 @@ sphinx-codeautolink
 sphinx-codeautolink makes code examples clickable by inserting links
 from individual code elements to the corresponding reference documentation.
 We aim for a minimal setup assuming your examples are already valid Python.
-Click any names in the example below for a demonstration:
+Click any undelined name in the example below for a demonstration:
 
 .. code:: python
 
@@ -42,7 +42,6 @@ sphinx-codeautolink can be installed from the following sources:
 .. code:: sh
 
     $ pip install sphinx-codeautolink
-    # or, alternatively:
     $ conda install -c conda-forge sphinx-codeautolink
 
 To enable sphinx-codeautolink, modify the extension list in ``conf.py``.
@@ -56,8 +55,8 @@ Note that the extension name uses an underscore rather than a hyphen.
    ]
 
 That's it! Now your code examples are linked.
-For ways of concatenating multiple examples
-and setting default import statements among other things,
+For ways of concatenating examples, setting default import statements,
+or customising link style among other things,
 have a look at the :ref:`reference` documentation.
 
 sphinx-codeautolink elsewhere:
@@ -70,7 +69,7 @@ Caveats
 For a more thorough explanation, see :ref:`about`.
 
 - Only works with HTML documentation
-- Only processes literal blocks, not inline code
+- Only processes blocks, not inline code
 - Doesn't run example code
 - Parsing and type hint resolving is incomplete
 

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/docs/src/reference.rst

@@ -57,14 +57,27 @@ Configuration
 
 .. confval:: codeautolink_warn_on_missing_inventory
 
-   Type: ``bool``. Issue warning when an object cannot be found in
+   Type: ``bool``. Warn when an object cannot be found in
    the inventory (autodoc or intersphinx). Defaults to :code:`False`.
 
 .. confval:: codeautolink_warn_on_failed_resolve
 
-   Type: ``bool``. Issue warning when failing to resolve the canonical location
+   Type: ``bool``. Warn when failing to resolve the canonical location
    of an object that a code element references. Defaults to :code:`False`.
 
+.. confval:: codeautolink_warn_on_no_backreference
+
+   Type: ``bool``. Warn when no backreference could be found
+   from reference documentation using the :rst:dir:`autolink-examples` table.
+   This highlights objects for which no tutorial, example or how-to exists.
+   Defaults to :code:`False`.
+
+.. confval:: codeautolink_warn_on_default_parse_fail
+
+   Type: ``bool``. Warn when a code block using the ``default`` lexer
+   cannot be parsed as Python. By default these cases are ignored by the
+   syntax highlighter, so we match the behavior. Defaults to :code:`False`.
+
 Directives
 ----------
 .. rst:directive:: .. autolink-examples:: object
@@ -89,7 +102,7 @@ Directives
 
 .. rst:directive:: .. autolink-concat:: [mode]
 
-   Toggle literal block concatenation.
+   Toggle block concatenation.
    Concatenated code blocks are treated as a continuous source,
    so that imports and statements in previous blocks affect later blocks.
    Concatenation is begun at the directive, not applied retroactively.
@@ -115,7 +128,7 @@ Directives
    Skip sphinx-codeautolink functionality.
    ``level``, if specified, must be one of:
 
-   - "next" - next block (default)
+   - "next" - next encountered block (default)
    - "section" - blocks until the next title
    - "file" - all blocks in the current file
    - "off" - turn skipping off
@@ -124,10 +137,16 @@ Directives
    it is not processed (e.g. non-Python blocks) to avoid placement confusion.
    Skipped blocks are ignored in block concatenation as well, and concatenation
    is resumed without breaks after skipping is over.
+   "Next" doesn't need to be specified right before the block that would consume
+   it. For e.g. literal blocks the skip directive would be inserted before the
+   preceding paragraph.
 
 CSS class
 ---------
 The CSS class used in all code block links is ``sphinx-codeautolink-a``.
+By default, the links only have a light blue hover colour.
+The style has been made more obvious in the documentation for demonstration.
+See :ref:`examples-css` for more information.
 
 Cleanup functions
 -----------------

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/docs/src/release_notes.rst

@@ -8,6 +8,26 @@ These release notes are based on
 sphinx-codeautolink adheres to
 `Semantic Versioning <https://semver.org>`_.
 
+0.17.0 (2025-02-18)
+-------------------
+Added
+*****
+- Add more Pygments lexer aliases in code blocks (:issue:`160`)
+- Introduce :confval:`codeautolink_warn_on_no_backreference` to highlight
+  where reference documentation does not appear to have
+  a corresponding tutorial or how-to (:issue:`161`)
+- Support the ``default`` lexer, literal blocks, ``.. highlight::`` directive
+  and ``highlight_language`` configuration (:issue:`166`)
+- Add :confval:`codeautolink_warn_on_default_parse_fail` to warn about
+  failing to link code blocks without a language parameter (:issue:`166`)
+- Detect and implicitly use ``pycon`` lexer for blocks that look like
+  console code (:issue:`168`)
+
+Fixed
+*****
+- Fix undocumented class attribute leading to a crash (:issue:`165`)
+- Fix skipping blocks with identical content to linked ones (:issue:`172`)
+
 0.16.2 (2025-01-16)
 -------------------
 - Fix regression in not handling malformed return types (:issue:`159`)

sphinx_codeautolink-0.17.0/docs/src/static/custom.css

@@ -0,0 +1,5 @@
+.sphinx-codeautolink-a{
+    border-bottom-color: #ccc;
+    border-bottom-style: solid;
+    border-bottom-width: 1px;
+}

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/pyproject.toml

@@ -75,6 +75,7 @@ extend-ignore = [
     "COM812", # recommended by ruff format
     "ISC001", # recommended by ruff format
     "PLR0913", # many arguments is fine
+    "PLR0915", # many statements is fine
 ]
 extend-unsafe-fixes = ["F401"]
 isort.split-on-trailing-comma = false
@@ -88,6 +89,7 @@ isort.split-on-trailing-comma = false
     "ANN", # annotations
     "S101", # assertions - necessary in tests
     "T201", # print - helpful in tests
+    "PLR2004", # magic number
 ]
 # TODO: support future annotated hints properly
 "tests/extension/src/test_project/__init__.py" = ["FA100"]

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/readme_pypi.rst

@@ -16,7 +16,6 @@ sphinx-codeautolink can be installed from the following sources:
 .. code:: sh
 
     $ pip install sphinx-codeautolink
-    # or, alternatively:
     $ conda install -c conda-forge sphinx-codeautolink
 
 Note that the library is in early development, so version pinning is advised.
@@ -31,9 +30,9 @@ Note that the extension name uses an underscore rather than a hyphen.
    ]
 
 That's it! Now your code examples are linked.
-For ways of concatenating multiple examples
-and setting default import statements among other things,
-have a look at the online documentation.
+For ways of concatenating examples, setting default import statements,
+or customising link style among other things,
+see the `online documentation <https://sphinx-codeautolink.rtfd.org>`_.
 
 .. |pyversions| image:: https://img.shields.io/pypi/pyversions/sphinx-codeautolink
    :alt: Python versions

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/src/sphinx_codeautolink/__init__.py

@@ -5,7 +5,7 @@ from sphinx.application import Sphinx
 from .extension import SphinxCodeAutoLink, backref, directive
 from .extension.block import clean_ipython, clean_pycon
 
-__version__ = "0.16.2"
+__version__ = "0.17.0"
 
 
 def setup(app: Sphinx):
@@ -43,6 +43,18 @@ def setup(app: Sphinx):
         rebuild="html",
         types=[bool],
     )
+    app.add_config_value(
+        "codeautolink_warn_on_no_backreference",
+        default=False,
+        rebuild="html",
+        types=[bool],
+    )
+    app.add_config_value(
+        "codeautolink_warn_on_default_parse_fail",
+        default=False,
+        rebuild="html",
+        types=[bool],
+    )
 
     app.add_directive("autolink-concat", directive.Concat)
     app.add_directive("autolink-examples", directive.Examples)

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/src/sphinx_codeautolink/extension/__init__.py

@@ -74,6 +74,9 @@ class SphinxCodeAutoLink:
         self.inventory_map: dict[str, str] = {}
         self.warn_missing_inventory = None
         self.warn_failed_resolve = None
+        self.warn_no_backreference = None
+        self.warn_default_parse_fail = None
+        self.highlight_lang = None
 
         # Populated once
         self.outdated_docs: set[str] = set()
@@ -103,6 +106,11 @@ class SphinxCodeAutoLink:
         self.inventory_map = app.config.codeautolink_inventory_map
         self.warn_missing_inventory = app.config.codeautolink_warn_on_missing_inventory
         self.warn_failed_resolve = app.config.codeautolink_warn_on_failed_resolve
+        self.warn_no_backreference = app.config.codeautolink_warn_on_no_backreference
+        self.warn_default_parse_fail = (
+            app.config.codeautolink_warn_on_default_parse_fail
+        )
+        self.highlight_lang = app.config.highlight_language
 
         # Append static resources path so references in setup() are valid
         app.config.html_static_path.append(
@@ -136,6 +144,8 @@ class SphinxCodeAutoLink:
             global_preface=self.global_preface,
             custom_blocks=self.custom_blocks,
             concat_default=self.concat_default,
+            default_highlight_lang=self.highlight_lang,
+            warn_default_parse_fail=self.warn_default_parse_fail,
         )
         doctree.walkabout(visitor)
         self.cache.transforms[visitor.current_document] = visitor.source_transforms
@@ -255,7 +265,11 @@ class SphinxCodeAutoLink:
             rm_vis = RemoveExtensionVisitor(doctree)
             return doctree.walkabout(rm_vis)
 
-        visitor = CodeRefsVisitor(doctree, code_refs=self.code_refs)
+        visitor = CodeRefsVisitor(
+            doctree,
+            code_refs=self.code_refs,
+            warn_no_backreference=self.warn_no_backreference,
+        )
         doctree.walk(visitor)
         return None
 

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/src/sphinx_codeautolink/extension/backref.py

@@ -4,6 +4,8 @@ from dataclasses import dataclass
 
 from docutils import nodes
 
+from sphinx_codeautolink.warn import logger, warn_type
+
 from .directive import DeferredExamples
 
 
@@ -56,10 +58,15 @@ class CodeRefsVisitor(nodes.SparseNodeVisitor):
     """Replace :class:`DeferredCodeReferences` with table of concrete references."""
 
     def __init__(
-        self, *args, code_refs: dict[str, list[CodeExample]], **kwargs
+        self,
+        *args,
+        code_refs: dict[str, list[CodeExample]],
+        warn_no_backreference: bool = False,
+        **kwargs,
     ) -> None:
         super().__init__(*args, **kwargs)
         self.code_refs = code_refs
+        self.warn_no_backreference = warn_no_backreference
 
     def unknown_departure(self, node) -> None:
         """Ignore unknown nodes."""
@@ -79,6 +86,11 @@ class CodeRefsVisitor(nodes.SparseNodeVisitor):
         items = sorted(set(items))
 
         if not items:
+            if self.warn_no_backreference:
+                msg = f"No backreference for: '{node.ref}'"
+                logger.warning(
+                    msg, type=warn_type, subtype="no_backreference", location=node
+                )
             # Remove surrounding paragraph too
             node.parent.parent.remove(node.parent)
             return

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/src/sphinx_codeautolink/extension/block.py

@@ -17,7 +17,18 @@ from sphinx_codeautolink.warn import logger, warn_type
 from .backref import CodeExample
 from .directive import ConcatMarker, PrefaceMarker, SkipMarker
 
-BUILTIN_BLOCKS = {"python": None, "py": None}
+# list from https://pygments.org/docs/lexers/#pygments.lexers.python.PythonLexer
+BUILTIN_BLOCKS = {
+    "default": None,
+    "python": None,
+    "python3": None,
+    "py": None,
+    "py3": None,
+    "pyi": None,
+    "sage": None,
+    "bazel": None,
+    "starlark": None,
+}
 
 
 @dataclass
@@ -94,7 +105,7 @@ else:
 
 
 class CodeBlockAnalyser(nodes.SparseNodeVisitor):
-    """Transform literal blocks of Python with links to reference documentation."""
+    """Transform blocks of Python with links to reference documentation."""
 
     def __init__(
         self,
@@ -103,6 +114,8 @@ class CodeBlockAnalyser(nodes.SparseNodeVisitor):
         global_preface: list[str],
         custom_blocks: dict[str, Callable[[str], str]],
         concat_default: bool,
+        default_highlight_lang: str | None,
+        warn_default_parse_fail: bool,
         **kwargs,
     ) -> None:
         super().__init__(*args, **kwargs)
@@ -120,6 +133,8 @@ class CodeBlockAnalyser(nodes.SparseNodeVisitor):
         self.concat_section = False
         self.concat_sources = []
         self.skip = None
+        self.highlight_lang = default_highlight_lang
+        self.warn_default_parse_fail = warn_default_parse_fail
 
     def unknown_visit(self, node) -> None:
         """Handle and delete custom directives, ignore others."""
@@ -152,6 +167,10 @@ class CodeBlockAnalyser(nodes.SparseNodeVisitor):
     def unknown_departure(self, node) -> None:
         """Ignore unknown nodes."""
 
+    def visit_highlightlang(self, node) -> None:
+        """Set expected highlight language."""
+        self.highlight_lang = node["lang"]
+
     def visit_title(self, node) -> None:
         """Track section names and break concatenation and skipping."""
         self.title_stack.append(node.astext())
@@ -175,9 +194,9 @@ class CodeBlockAnalyser(nodes.SparseNodeVisitor):
 
     def visit_literal_block(self, node: nodes.literal_block):
         """Visit a generic literal block."""
-        return self.parse_source(node, node.get("language", None))
+        return self.parse_source(node, node.get("language", self.highlight_lang))
 
-    def parse_source(
+    def parse_source(  # noqa: C901
         self, node: nodes.literal_block | nodes.doctest_block, language: str | None
     ) -> None:
         """Analyse Python code blocks."""
@@ -189,14 +208,27 @@ class CodeBlockAnalyser(nodes.SparseNodeVisitor):
             self.skip = None
 
         if (
-            skip
-            or len(node.children) != 1
+            len(node.children) != 1
             or not isinstance(node.children[0], nodes.Text)
             or language not in self.valid_blocks
         ):
             return
 
         source = node.children[0].astext()
+        example = CodeExample(
+            self.current_document, self.current_refid, list(self.title_stack)
+        )
+        transform = SourceTransform(source, [], example, node.line)
+        self.source_transforms.append(transform)
+
+        if skip:
+            return
+
+        # Sphinx uses a similar trick to use pycon implicitly (#168)
+        pycon_candidates = ("py", "python", "py3", "python3", "default", "pycon3")
+        if source.startswith(">>>") and language in pycon_candidates:
+            language = "pycon"
+
         transformer = self.transformers[language]
         if transformer:
             try:
@@ -209,11 +241,7 @@ class CodeBlockAnalyser(nodes.SparseNodeVisitor):
                 return
         else:
             clean_source = source
-        example = CodeExample(
-            self.current_document, self.current_refid, list(self.title_stack)
-        )
-        transform = SourceTransform(source, [], example, node.line)
-        self.source_transforms.append(transform)
+        transform.source = source
 
         modified_source = "\n".join(
             self.global_preface + self.concat_sources + prefaces + [clean_source]
@@ -221,8 +249,11 @@ class CodeBlockAnalyser(nodes.SparseNodeVisitor):
         try:
             names = parse_names(modified_source, node)
         except SyntaxError as e:
+            if language == "default" and not self.warn_default_parse_fail:
+                return
+
             show_source = self._format_source_for_error(
-                self.global_preface, self.concat_sources, prefaces, source
+                self.global_preface, self.concat_sources, prefaces, transform.source
             )
             msg = self._parsing_error_msg(e, language, show_source)
             logger.warning(msg, type=warn_type, subtype="parse_block", location=node)

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/src/sphinx_codeautolink/extension/directive.py

@@ -62,7 +62,7 @@ class ConcatMarker(nodes.Element):
 
 
 class Concat(Directive):
-    """Toggle and cut literal block concatenation in a document."""
+    """Toggle and cut block concatenation in a document."""
 
     has_content = False
     required_arguments = 0

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0}/src/sphinx_codeautolink/extension/resolve.py

@@ -86,8 +86,9 @@ def locate_type(cursor: Cursor, components: tuple[str, ...], inventory) -> Curso
             with suppress(AttributeError, TypeError):
                 cursor.location = fully_qualified_name(cursor.value)
 
+        # Check bases if member not found in current class
         if isclass(previous.value) and cursor.location not in inventory:
-            for val in previous.value.__mro__:
+            for val in previous.value.__mro__[1:]:
                 name = fully_qualified_name(val)
                 if name + "." + component in inventory:
                     previous.location = name

sphinx_codeautolink-0.17.0/src/sphinx_codeautolink/static/sphinx-codeautolink.css

@@ -0,0 +1,13 @@
+.sphinx-codeautolink-a{
+    color: inherit;
+    text-decoration: none;
+}
+.sphinx-codeautolink-a:link{
+    color: inherit;
+}
+.sphinx-codeautolink-a:visited{
+    color: inherit;
+}
+.sphinx-codeautolink-a:hover{
+    color: rgb(0, 139, 139);
+}

{sphinx_codeautolink-0.16.2 → sphinx_codeautolink-0.17.0/src/sphinx_codeautolink.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: sphinx-codeautolink
-Version: 0.16.2
+Version: 0.17.0
 Summary: Automatic links from code examples to reference documentation.
 Author-email: Felix Hildén <felix.hilden@gmail.com>
 Maintainer-email: Felix Hildén <felix.hilden@gmail.com>
@@ -70,7 +70,6 @@ sphinx-codeautolink can be installed from the following sources:
 .. code:: sh
 
     $ pip install sphinx-codeautolink
-    # or, alternatively:
     $ conda install -c conda-forge sphinx-codeautolink
 
 Note that the library is in early development, so version pinning is advised.
@@ -85,9 +84,9 @@ Note that the extension name uses an underscore rather than a hyphen.
    ]
 
 That's it! Now your code examples are linked.
-For ways of concatenating multiple examples
-and setting default import statements among other things,
-have a look at the online documentation.
+For ways of concatenating examples, setting default import statements,
+or customising link style among other things,
+see the `online documentation <https://sphinx-codeautolink.rtfd.org>`_.
 
 .. |pyversions| image:: https://img.shields.io/pypi/pyversions/sphinx-codeautolink
    :alt: Python versions