f

Author: felix-hilden

docs/src/conf.py

@@ -57,6 +57,7 @@
 plot_html_show_source_link = False
 
 html_static_path = ["static"]
+html_css_files = ["custom.css"]
 
 
 def setup(app) -> None:
@@ -66,9 +67,3 @@ def setup(app) -> None:
         objname="configuration value",
         indextemplate="pair: %s; configuration value",
     )
-    app.connect("html-page-context", html_page_context_handler)
-
-
-def html_page_context_handler(app, pagename, templatename, context, doctree):
-    if pagename == "index":
-        app.add_css_file("custom.css")

docs/src/examples.rst

@@ -300,24 +300,29 @@ 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
 
    # conf.py
    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 dotted lines 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-color: #aaa;
        border-bottom-style: dotted;
        border-bottom-width: 1px;
    }

docs/src/index.rst

@@ -1,5 +1,3 @@
-.. _index:
-
 sphinx-codeautolink
 ===================
 |license|
@@ -18,9 +16,6 @@ Click any names in the example below for a demonstration:
        print(knight.taunt())
        knight.scratch()
 
-The link styles in this document have been modified to be obvious.
-The rest of this documentation uses the more subtle default style.
-
 A directive to create a table of references from code examples to a single
 definition is also provided, which can also be integrated with autodoc entries.
 For example, :code:`.. autolink-examples:: lib.Knight` produces:
@@ -61,8 +56,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:

docs/src/reference.rst

@@ -141,19 +141,9 @@ Directives
 CSS class
 ---------
 The CSS class used in all code block links is ``sphinx-codeautolink-a``.
-An example of more obvious links is on the :ref:`landing page <index>`.
-The styles can be configured for all pages by defining ``html_static_path``
-and ``html_css_files`` to include in the documentation.
-To include only in specific documents, see the ``html-page-context`` event
-and the :meth:`Sphinx.add_css_file` function.
-
-.. code:: css
-
-   .sphinx-codeautolink-a{
-       border-bottom-color: #aaa;
-       border-bottom-style: dotted;
-       border-bottom-width: 2px;
-   }
+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
 -----------------

docs/src/release_notes.rst

@@ -19,7 +19,6 @@ sphinx-codeautolink adheres to
   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`)
-- Improve default link style to unset colors and use an underline (:issue:`171`)
 
 0.16.2 (2025-01-16)
 -------------------

docs/src/static/custom.css

@@ -1,5 +1,4 @@
 .sphinx-codeautolink-a{
-    color: unset;
     border-bottom-color: #aaa;
     border-bottom-style: dotted;
     border-bottom-width: 1px;

src/sphinx_codeautolink/static/sphinx-codeautolink.css

@@ -1,15 +1,12 @@
 .sphinx-codeautolink-a{
-    color: unset;
+    color: inherit;
     text-decoration: none;
-    border-bottom-color: #aaa;
-    border-bottom-style: dotted;
-    border-bottom-width: 1px;
 }
 .sphinx-codeautolink-a:link{
-    color: unset;
+    color: inherit;
 }
 .sphinx-codeautolink-a:visited{
-    color: unset;
+    color: inherit;
 }
 .sphinx-codeautolink-a:hover{
     color: rgb(0, 139, 139);