sphinx-codeautolink 0.15.0__tar.gz → 0.15.2__tar.gz

{sphinx-codeautolink-0.15.0/src/sphinx_codeautolink.egg-info → sphinx_codeautolink-0.15.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sphinx-codeautolink
-Version: 0.15.0
+Version: 0.15.2
 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>
@@ -47,8 +47,11 @@ Classifier: Topic :: Documentation :: Sphinx
 Classifier: Topic :: Software Development :: Documentation
 Requires-Python: >=3.7
 Description-Content-Type: text/x-rst
-Provides-Extra: ipython
 License-File: LICENSE
+Requires-Dist: sphinx>=3.2.0
+Requires-Dist: beautifulsoup4>=4.8.1
+Provides-Extra: ipython
+Requires-Dist: ipython!=8.7.0; extra == "ipython"
 
 sphinx-codeautolink
 ===================

sphinx_codeautolink-0.15.2/docs/requirements.txt

@@ -0,0 +1,6 @@
+# Manually pin Sphinx + docs requirements
+sphinx==7.2.6
+sphinx-rtd-theme==2.0.0
+docutils==0.19
+matplotlib==3.8.3
+ipython==8.22.2

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/docs/src/404.rst

@@ -1,3 +1,5 @@
+:orphan:
+
 sphinx-codeautolink
 ===================
 

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/docs/src/about.rst

@@ -51,6 +51,13 @@ Caveats
 
 Sphinx semantics
 ----------------
+Warnings
+********
+For an easier time with debugging, we recommend enabling all warnings,
+treating them as errors with ``-W`` and only ignoring specific warning types
+with :confval:`suppress_warnings`. This is also easier if
+:confval:`show_warning_types` is set.
+
 Clean build
 ***********
 For correct partial builds, code reference information is saved to a file
@@ -64,6 +71,7 @@ Sphinx cache
 A function specified in :confval:`codeautolink_custom_blocks` prevents Sphinx
 from caching documentation results. Consider using an importable instead.
 For more information, see the discussion in :issue:`76`.
+You can also suppress the warning.
 
 Parallel build and custom parsers
 *********************************

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/docs/src/conf.py

@@ -32,10 +32,12 @@ extensions = [
 # Builtin options
 html_theme = "sphinx_rtd_theme"
 python_use_unqualified_type_names = True
+show_warning_types = True
 
 # Extension options
 codeautolink_autodoc_inject = True
 codeautolink_custom_blocks = {"python3": None, "pycon3": clean_pycon}
+suppress_warnings = ["config.cache"]
 
 autodoc_default_options = {"members": True, "undoc-members": True}
 autodoc_typehints = "description"

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/docs/src/release_notes.rst

@@ -8,6 +8,15 @@ These release notes are based on
 sphinx-codeautolink adheres to
 `Semantic Versioning <https://semver.org>`_.
 
+0.15.2 (2024-06-03)
+-------------------
+- Fix matching of ``import a, b`` (:issue:`142`)
+
+0.15.1 (2024-04-17)
+-------------------
+- Fix linking blocks with line numbers (:issue:`137`)
+- Use safer version of ``mro`` to support ``type`` (:issue:`120`)
+
 0.15.0 (2023-02-05)
 -------------------
 - Fix handling of syntax errors in parsed blocks (:issue:`135`)

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/src/sphinx_codeautolink/__init__.py

@@ -1,10 +1,11 @@
 """Sphinx extension for linking code examples to reference documentation."""
+
 from sphinx.application import Sphinx
 
 from .extension import SphinxCodeAutoLink, backref, directive
 from .extension.block import clean_ipython, clean_pycon  # NOQA
 
-__version__ = "0.15.0"
+__version__ = "0.15.2"
 
 
 def setup(app: Sphinx):

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/src/sphinx_codeautolink/extension/__init__.py

@@ -1,4 +1,5 @@
 """Sphinx extension implementation."""
+
 from dataclasses import dataclass
 from functools import wraps
 from pathlib import Path

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/src/sphinx_codeautolink/extension/backref.py

@@ -1,4 +1,5 @@
 """Backreference tables implementation."""
+
 from dataclasses import dataclass
 from typing import Dict, List
 

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/src/sphinx_codeautolink/extension/block.py

@@ -1,5 +1,7 @@
 """Code block processing."""
+
 import re
+from copy import copy
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Callable, Dict, List, Optional, Tuple, Union
@@ -304,7 +306,13 @@ def link_html(
 
     for trans in transforms:
         for ix in range(len(inners)):
-            if trans.source.rstrip() == "".join(inners[ix].strings).rstrip():
+            candidate = copy(inners[ix])
+
+            # remove line numbers for matching
+            for lineno in candidate.find_all("span", attrs={"class": "linenos"}):
+                lineno.extract()
+
+            if trans.source.rstrip() == "".join(candidate.strings).rstrip():
                 inner = inners.pop(ix)
                 break
         else:
@@ -368,12 +376,14 @@ no_dot_prere = r'(?<!<span class="o">\.</span>)()'
 call_dot_prere = r'(\)</span>\s*<span class="o">\.</span>\s*)'
 import_prere = (
     r'((<span class="kn">import</span>\s+(<span class="p">\(</span>\s*)?)'
-    r'|(<span class="p">,</span>\s*))'
+    r'|(<span class="[op]">,</span>\s*))'
 )
 from_prere = r'(<span class="kn">from</span>\s+)'
 
 no_dot_postre = r'(?!(<span class="o">\.)|(</a>))'
-import_postre = r'(?=($)|(\s+)|(<span class="p">,</span>)|(<span class="p">\)))(?!</a>)'
+import_postre = (
+    r'(?=($)|(\s+)|(<span class="[op]">,</span>)|(<span class="p">\)))(?!</a>)'
+)
 from_postre = r'(?=\s*<span class="kn">import</span>)'
 
 

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/src/sphinx_codeautolink/extension/cache.py

@@ -1,4 +1,5 @@
 """Extension data cache."""
+
 import json
 from dataclasses import asdict
 from pathlib import Path

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/src/sphinx_codeautolink/extension/directive.py

@@ -1,4 +1,5 @@
 """Directive implementations."""
+
 from docutils import nodes
 from docutils.parsers.rst import Directive, directives
 from sphinx import addnodes

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/src/sphinx_codeautolink/extension/resolve.py

@@ -1,4 +1,5 @@
 """Resolve import locations and type hints."""
+
 from dataclasses import dataclass
 from functools import lru_cache
 from importlib import import_module
@@ -82,7 +83,7 @@ def locate_type(cursor: Cursor, components: Tuple[str, ...], inventory) -> Curso
                 pass
 
         if isclass(previous.value) and cursor.location not in inventory:
-            for val in previous.value.mro():
+            for val in previous.value.__mro__:
                 name = fully_qualified_name(val)
                 if name + "." + component in inventory:
                     previous.location = name

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/src/sphinx_codeautolink/parse.py

@@ -1,4 +1,5 @@
 """Analyse AST of code blocks to determine used names and their sources."""
+
 import ast
 import builtins
 import sys

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/src/sphinx_codeautolink/warn.py

@@ -1,4 +1,5 @@
 """Logging definitions."""
+
 from sphinx.util.logging import getLogger
 
 logger = getLogger("sphinx_codeautolink")

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2/src/sphinx_codeautolink.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sphinx-codeautolink
-Version: 0.15.0
+Version: 0.15.2
 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>
@@ -47,8 +47,11 @@ Classifier: Topic :: Documentation :: Sphinx
 Classifier: Topic :: Software Development :: Documentation
 Requires-Python: >=3.7
 Description-Content-Type: text/x-rst
-Provides-Extra: ipython
 License-File: LICENSE
+Requires-Dist: sphinx>=3.2.0
+Requires-Dist: beautifulsoup4>=4.8.1
+Provides-Extra: ipython
+Requires-Dist: ipython!=8.7.0; extra == "ipython"
 
 sphinx-codeautolink
 ===================

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/src/sphinx_codeautolink.egg-info/SOURCES.txt

@@ -63,6 +63,7 @@ tests/extension/ref/custom_block_imported.txt
 tests/extension/ref/empty_project.txt
 tests/extension/ref/inventory_map_is_needed.txt
 tests/extension/ref/inventory_map_not_needed.txt
+tests/extension/ref/line_numbers.txt
 tests/extension/ref/non_python_block.txt
 tests/extension/ref/preface_concatenated.txt
 tests/extension/ref/preface_consumed_non_python.txt
@@ -91,6 +92,7 @@ tests/extension/ref/ref_import_as.txt
 tests/extension/ref/ref_import_from.txt
 tests/extension/ref/ref_import_from_complex.txt
 tests/extension/ref/ref_import_multiple.txt
+tests/extension/ref/ref_import_multiple_libs.txt
 tests/extension/ref/ref_import_star.txt
 tests/extension/ref/ref_import_submodule.txt
 tests/extension/ref/ref_imported_func.txt

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/tests/extension/__init__.py

@@ -28,7 +28,7 @@ codeautolink_warn_on_failed_resolve = True
 """
 
 any_whitespace = re.compile(r"\s*")
-ref_tests = list(Path(__file__).with_name("ref").glob("*.txt"))
+ref_tests = [(p.name, p) for p in Path(__file__).with_name("ref").glob("*.txt")]
 ref_xfails = {
     "ref_fluent_attrs.txt": sys.version_info < (3, 8),
     "ref_fluent_call.txt": sys.version_info < (3, 8),
@@ -47,8 +47,8 @@ def assert_links(file: Path, links: list):
         assert s == link
 
 
-@pytest.mark.parametrize("file", ref_tests)
-def test_references(file: Path, tmp_path: Path):
+@pytest.mark.parametrize(("name", "file"), ref_tests)
+def test_references(name: str, file: Path, tmp_path: Path):
     """
     Basic extension tests for reference building.
 
@@ -72,6 +72,7 @@ def test_references(file: Path, tmp_path: Path):
         links = []
 
     files = {"conf.py": default_conf + conf, "index.rst": index}
+    print(f"Building file {name}.")
     result_dir = _sphinx_build(tmp_path, "html", files)
 
     assert_links(result_dir / "index.html", links)

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/tests/extension/ref/custom_block.txt

@@ -5,6 +5,7 @@ def clean(s):
     return s, s.replace("-*-", "")
 
 codeautolink_custom_blocks = {"python": clean}
+suppress_warnings = ["config.cache"]
 # split
 Test project
 ============

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/tests/extension/ref/custom_block_imported.txt

@@ -2,6 +2,7 @@ test_project
 test_project.bar
 # split
 codeautolink_custom_blocks = {"python": "parser_func.clean"}
+suppress_warnings = ["config.cache"]
 # split
 Test project
 ============

sphinx_codeautolink-0.15.2/tests/extension/ref/line_numbers.txt

@@ -0,0 +1,14 @@
+test_project
+test_project.bar
+# split
+# split
+Test project
+============
+
+.. code-block:: python
+   :linenos:
+
+   import test_project
+   test_project.bar()
+
+.. automodule:: test_project

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/tests/extension/ref/ref_extdoctest_doctest.txt

@@ -7,6 +7,7 @@ test_project.Foo
 from sphinx_codeautolink.extension.block import clean_pycon
 extensions.append("sphinx.ext.doctest")
 codeautolink_custom_blocks = {"pycon3": clean_pycon}
+suppress_warnings = ["config.cache"]
 # split
 Test project
 ============

sphinx_codeautolink-0.15.2/tests/extension/ref/ref_import_multiple_libs.txt

@@ -0,0 +1,17 @@
+json
+math
+# split
+extensions = [
+    "sphinx.ext.intersphinx",
+    "sphinx_codeautolink",
+]
+intersphinx_mapping = {"python": ('https://docs.python.org/3/', None)}
+# split
+Test project
+============
+
+.. code:: python
+
+   import json, math
+
+.. automodule:: test_project

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/tests/extension/src/test_project/__init__.py

@@ -1,4 +1,5 @@
 """Docstring."""
+
 from typing import Optional, Union
 
 from .sub import SubBar, subfoo  # NOQA

{sphinx-codeautolink-0.15.0 → sphinx_codeautolink-0.15.2}/tox.ini

@@ -60,7 +60,7 @@ commands = pydocstyle src
 description = Build Sphinx documentation
 allowlist_externals = sphinx-build
 change_dir = docs
-commands = sphinx-build -M html src build
+commands = sphinx-build -M html src build -W
 
 [testenv:black-check]
 description = Check code formatting
@@ -103,7 +103,7 @@ commands_pre =
 commands =
     python -m build
     twine check --strict dist/*
-    twine upload dist/*
+    twine upload dist/* --config-file .pypirc
 commands_post =
     lin,mac: rm -r dist
     win: cmd /c rmdir /s /q dist

sphinx-codeautolink-0.15.0/docs/requirements.txt

@@ -1,6 +0,0 @@
-# Manually pin Sphinx + docs requirements
-sphinx==5.3.0
-sphinx-rtd-theme==1.1.1
-docutils==0.17.1
-matplotlib==3.4.3
-ipython==8.6.0