Inject link CSS (#3)

Author: felix-hilden

docs/src/index.rst

@@ -6,6 +6,7 @@ Automatic links from Python code examples to reference documentation
 at the flick of a switch!
 sphinx-codeautolink analyses the code in your documentation
 and inserts links to definitions that you use.
+Click any names in the code example below.
 
 .. code:: python
 

src/sphinx_codeautolink/__init__.py

@@ -15,6 +15,7 @@
 
 def setup(app: Sphinx):
     """Set up extension, directives and events."""
+    app.add_css_file('sphinx-codeautolink.css')
     app.add_config_value('codeautolink_concat_blocks', 'none', 'html', types=[str])
     app.add_config_value('codeautolink_autodoc_inject', True, 'html', types=[bool])
 
@@ -23,7 +24,7 @@ def setup(app: Sphinx):
     app.add_directive('implicit-import', ImplicitImport)
     app.add_directive('autolink-skip', AutoLinkSkip)
 
-    app.connect('builder-inited', state.read_references)
+    app.connect('builder-inited', state.build_inited)
     app.connect('doctree-read', state.parse_blocks)
     app.connect('doctree-resolved', state.generate_backref_tables)
     app.connect('build-finished', state.apply_links)

src/sphinx_codeautolink/extension/__init__.py

@@ -33,12 +33,18 @@ def flat_refs(self):
 
         return self._flat_refs
 
-    def read_references(self, app):
-        """Nullify extension if not on HTML builder, read ref file."""
+    def build_inited(self, app):
+        """Handle initial setup."""
         if app.builder.name != 'html':
             self.do_nothing = True
             return
 
+        # Append static resources path so references in setup() are valid
+        app.config.html_static_path.append(
+            str(Path(__file__).parent.with_name('static').absolute())
+        )
+
+        # Read serialised references from last build
         refs_file = Path(app.srcdir) / self.code_refs_file
         if not refs_file.exists():
             return

src/sphinx_codeautolink/extension/block.py

@@ -171,7 +171,10 @@ def link_html(
     inners = [block.select('div > pre')[0] for block in blocks]
 
     up_lvls = len(document.relative_to(out_dir).parents) - 1
-    link_pattern = '<a href="' + '../' * up_lvls + '{link}" title="{title}">{text}</a>'
+    link_pattern = (
+        '<a href="' + '../' * up_lvls
+        + '{link}" title="{title}" class="sphinx-codeautolink-a">{text}</a>'
+    )
     name_pattern = '<span class="n">{name}</span>'
     period = '<span class="o">.</span>'
 

src/sphinx_codeautolink/static/sphinx-codeautolink.css

@@ -0,0 +1,4 @@
+.sphinx-codeautolink-a:link{color: inherit}
+.sphinx-codeautolink-a:active{color: inherit}
+.sphinx-codeautolink-a:visited{color: inherit}
+.sphinx-codeautolink-a:hover{color: rgb(0, 139, 139)}