Declare CSS as public, document modifying style (#3)

Author: felix-hilden

docs/src/examples.rst

@@ -245,3 +245,28 @@ 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.
+
+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']
+
+.. code:: css
+
+   /* static/custom.css */
+   .sphinx-codeautolink-a{
+       border-bottom-color: rgb(0, 0, 0);
+       border-bottom-style: dotted;
+       border-bottom-width: 1px;
+   }
+   .sphinx-codeautolink-a:hover{
+       color: rgb(255, 139, 139);
+   }

docs/src/reference.rst

@@ -2,7 +2,7 @@
 
 Reference
 =========
-The public API of sphinx-codeautolink consists only of the configuration
+The public API of sphinx-codeautolink consists mostly of the configuration
 and directives made available to Sphinx.
 The extension is enabled with the name ``sphinx_codeautolink``.
 During the build phase, a cache containing code example information is saved
@@ -106,10 +106,13 @@ Directives
    Skipped blocks are ignored in block concatenation as well, and concatenation
    is resumed without breaks after skipping is over.
 
+CSS class
+---------
+The CSS class used in all code block links is ``sphinx-codeautolink-a``.
+
 Cleanup function
 ----------------
-An exception to the public API policy is made for a single function usable
-for cleaning ``pycon`` blocks.
+The function below is usable for cleaning ``pycon`` code blocks.
 It is intended to be used with :confval:`codeautolink_custom_blocks`.
 
 .. autofunction:: sphinx_codeautolink.clean_pycon

docs/src/release_notes.rst

@@ -10,6 +10,7 @@ sphinx-codeautolink adheres to
 
 Unreleased
 ----------
+- Declare CSS class as public API (:issue:`3`)
 - Add ability to link to subclass documentation (:issue:`68`)
 
 0.6.0 (2021-11-21)