Filter out links from concatenated sources (#14)

Author: felix-hilden

docs/src/conf.py

@@ -16,6 +16,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx.ext.intersphinx",
+    "sphinx.ext.extlinks",
     "sphinx_rtd_theme",
     "sphinx_codeautolink",
 ]
@@ -34,3 +35,6 @@
     "numpy": ("https://numpy.org/doc/stable/", None),
     "matplotlib": ("https://matplotlib.org/stable/", None),
 }
+extlinks = {
+    'issue': ('https://github.com/felix-hilden/sphinx-codeautolink/issues/%s', '#'),
+}

docs/src/examples.rst

@@ -79,12 +79,14 @@ Examples interlaced with explanations can make for more comprehensible docs.
 
    import sphinx_codeautolink
 
+   sphinx_codeautolink.setup()
+
 After explaining some details, the following block may continue where
 the previous left off.
 
 .. code:: python
 
-   sphinx_codeautolink.setup()
+   sphinx_codeautolink.parse.parse_names()
 
 This was achieved with::
 

docs/src/release_notes.rst

@@ -8,6 +8,10 @@ These release notes are based on
 sphinx-codeautolink adheres to
 `Semantic Versioning <https://semver.org>`_.
 
+Unreleased
+----------
+- Correctly filter out names from concatenated sources (:issue:`14`)
+
 0.1.0 (2021-09-22)
 ------------------
 Initial release

src/sphinx_codeautolink/extension/block.py

@@ -130,7 +130,7 @@ def visit_literal_block(self, node: nodes.literal_block):
             raise ParsingError(msg) from e
 
         if implicit_imports or self.concat_sources:
-            concat_lens = [source.count('\n') + 1 for source in self.concat_sources]
+            concat_lens = [s.count('\n') + 1 for s in self.concat_sources]
             hidden_len = len(implicit_imports) + sum(concat_lens)
             for name in names:
                 name.lineno -= hidden_len
@@ -144,6 +144,9 @@ def visit_literal_block(self, node: nodes.literal_block):
             self.current_document, self.current_refid, list(self.title_stack)
         )
         for name in names:
+            if name.lineno < 1:
+                continue  # From concatenated source
+
             if name.lineno != name.end_lineno:
                 msg = (
                     'sphinx-codeautolinks: multiline names are not supported, '