sphinx-codeautolink 0.17.1__tar.gz → 0.17.2__tar.gz

{sphinx_codeautolink-0.17.1/src/sphinx_codeautolink.egg-info → sphinx_codeautolink-0.17.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: sphinx-codeautolink
-Version: 0.17.1
+Version: 0.17.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>

{sphinx_codeautolink-0.17.1 → sphinx_codeautolink-0.17.2}/docs/src/about.rst

@@ -79,6 +79,12 @@ Locally defined custom block parsers in :confval:`codeautolink_custom_blocks`
 cannot be passed to Pickle, which prevents parallel Sphinx builds.
 Please consider using an importable function instead.
 
+Priority
+********
+The extension parses code blocks in the ``doctree-read`` Sphinx event.
+The priority is set to 490 to catch nodes removed by ``sphinx.ext.doctest``
+(priority 500). In other cases the priority of the extension is default.
+
 Copying code blocks
 -------------------
 If you feel like code links make copying code a bit more difficult,

{sphinx_codeautolink-0.17.1 → sphinx_codeautolink-0.17.2}/docs/src/examples.rst

@@ -215,24 +215,18 @@ Please specify a ``type`` in :rst:dir:`autolink-examples`:
 
 Doctest code blocks
 -------------------
-Using the ``sphinx.ext.doctest`` extension for code examples requires
-setting up :confval:`codeautolink_custom_blocks`.
-To help in that, :func:`clean_pycon <sphinx_codeautolink.clean_pycon>`
-is provided as a ready-made transformer.
-
-.. code:: python
+Using the ``sphinx.ext.doctest`` extension for code examples only requires
+activating the extension::
 
    extensions = [
        ...,
        "sphinx.ext.doctest",
    ]
-   codeautolink_custom_blocks = {
-       "python3": None,
-       "pycon3": "sphinx_codeautolink.clean_pycon",
-   }
 
 ``doctest`` and ``testcode`` blocks now work as expected.
-However, any test setup and teardown code is not taken into account.
+Code in :rst:dir:`testsetup` is considered to be the first block
+:rst:dir:`autolink-preface` before each matching test group.
+However, `skipif` is not supported.
 
 .. doctest::
 

{sphinx_codeautolink-0.17.1 → sphinx_codeautolink-0.17.2}/docs/src/release_notes.rst

@@ -8,6 +8,11 @@ These release notes are based on
 sphinx-codeautolink adheres to
 `Semantic Versioning <https://semver.org>`_.
 
+0.17.2 (2025-03-02)
+-------------------
+- Support :rst:dir:`testsetup` from ``sphinx.ext.doctest`` as another
+  type of preface (:issue:`186`)
+
 0.17.1 (2025-02-24)
 -------------------
 - Add translations via i18n (:issue:`164`)

{sphinx_codeautolink-0.17.1 → sphinx_codeautolink-0.17.2}/src/sphinx_codeautolink/__init__.py

@@ -8,7 +8,7 @@ from .extension import SphinxCodeAutoLink, backref, directive
 from .extension.block import clean_ipython, clean_pycon
 from .extension.translation import MESSAGE_CATALOG_NAME
 
-__version__ = "0.17.1"
+__version__ = "0.17.2"
 
 
 def setup(app: Sphinx):
@@ -66,7 +66,7 @@ def setup(app: Sphinx):
 
     app.connect("builder-inited", state.build_inited)
     app.connect("autodoc-process-docstring", state.autodoc_process_docstring)
-    app.connect("doctree-read", state.parse_blocks)
+    app.connect("doctree-read", state.parse_blocks, priority=490)
     app.connect("env-merge-info", state.merge_environments)
     app.connect("env-purge-doc", state.purge_doc_from_environment)
     app.connect("env-updated", state.create_references)

{sphinx_codeautolink-0.17.1 → sphinx_codeautolink-0.17.2}/src/sphinx_codeautolink/extension/block.py

@@ -125,6 +125,7 @@ class CodeBlockAnalyser(nodes.SparseNodeVisitor):
         self.global_preface = global_preface
         self.file_preface = []
         self.prefaces = []
+        self.doctest_preface: dict[str, list[str]] = {}
         self.transformers = BUILTIN_BLOCKS.copy()
         self.transformers.update(custom_blocks)
         self.valid_blocks = self.transformers.keys()
@@ -198,10 +199,21 @@ class CodeBlockAnalyser(nodes.SparseNodeVisitor):
         """Pop latest title."""
         self.title_stack.pop()
 
-    def visit_doctest_block(self, node):
+    def visit_doctest_block(self, node: nodes.doctest_block):
         """Visit a Python doctest block."""
         return self.parse_source(node, "pycon")
 
+    def visit_comment(self, node: nodes.comment):
+        """Visit an ext.doctest setup block."""
+        if node.get("testnodetype") == "testsetup":
+            groups = node["groups"]
+            lines = [ln for c in node.children for ln in c.astext().split("\n")]
+            for g in groups:
+                if g == "*":
+                    self.doctest_preface = {"*": lines}
+                else:
+                    self.doctest_preface[g] = lines
+
     def visit_literal_block(self, node: nodes.literal_block):
         """Visit a generic literal block."""
         return self.parse_source(node, node.get("language", self.highlight_lang))
@@ -213,6 +225,15 @@ class CodeBlockAnalyser(nodes.SparseNodeVisitor):
         prefaces = self.prefaces
         self.prefaces = []
 
+        if node.get("testnodetype") == "doctest":
+            groups = node["groups"]
+            doctest_prefaces = [
+                ln
+                for g in groups
+                for ln in self.doctest_preface.get(g, self.doctest_preface.get("*", []))
+            ]
+            prefaces = doctest_prefaces + prefaces
+
         skip = self.skip
         if skip == "next":
             self.skip = None

sphinx_codeautolink-0.17.2/src/sphinx_codeautolink/locale/fr/LC_MESSAGES/sphinx-codeautolink.po

@@ -0,0 +1,25 @@
+# French translations for sphinx-codeautolink.
+# Copyright (C) 2025 ORGANIZATION
+# This file is distributed under the same license as the sphinx-codeautolink project.
+# Colin Marquardt <cmarqu42@gmail.com>, 2025.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: 1\n"
+"Report-Msgid-Bugs-To: cmarqu42@gmail.com\n"
+"POT-Creation-Date: 2025-02-23 17:30+0200\n"
+"PO-Revision-Date: 2025-02-25 22:23+0100\n"
+"Last-Translator: Colin Marquardt <cmarqu42@gmail.com>\n"
+"Language: fr\n"
+"Language-Team: Colin Marquardt <cmarqu42@gmail.com>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.17.0\n"
+
+msgid "References to"
+msgstr "Références à"
+
+msgid "Expand for references to"
+msgstr "Étendre pour les références à"

sphinx_codeautolink-0.17.2/src/sphinx_codeautolink/locale/nl/LC_MESSAGES/sphinx-codeautolink.po

@@ -0,0 +1,27 @@
+# Dutch (Netherlands) translations for sphinx-codeautolink.
+# Copyright (C) 2025 ORGANIZATION
+# This file is distributed under the same license as the sphinx-codeautolink
+# project.
+# Trevor James Smith <smith.trevorj@ouranos.ca>, 2025.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version:  1\n"
+"Report-Msgid-Bugs-To: smith.trevorj@ouranos.ca\n"
+"POT-Creation-Date: 2025-02-23 17:30+0200\n"
+"PO-Revision-Date: 2025-02-26 09:04-0500\n"
+"Last-Translator: Trevor James Smith <smith.trevorj@ouranos.ca>\n"
+"Language: nl\n"
+"Language-Team: Trevor James Smith <smith.trevorj@ouranos.ca>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.17.0\n"
+
+msgid "References to"
+msgstr "Referenties naar"
+
+msgid "Expand for references to"
+msgstr "Uitklappen voor referenties naar"
+

sphinx_codeautolink-0.17.2/src/sphinx_codeautolink/locale/ru/LC_MESSAGES/sphinx-codeautolink.po

@@ -0,0 +1,25 @@
+# Russian translations for sphinx-codeautolink.
+# Copyright (C) 2025 ORGANIZATION
+# This file is distributed under the same license as the sphinx-codeautolink project.
+# Yuriy Skalko <yuriy.skalko@gmail.com>, 2025.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: 1\n"
+"Report-Msgid-Bugs-To: yuriy.skalko@gmail.com\n"
+"POT-Creation-Date: 2025-02-24 17:30+0200\n"
+"PO-Revision-Date: 2025-02-24 18:42+0100\n"
+"Last-Translator: Yuriy Skalko <yuriy.skalko@gmail.com>\n"
+"Language: ru\n"
+"Language-Team: Yuriy Skalko <yuriy.skalko@gmail.com>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.17.0\n"
+
+msgid "References to"
+msgstr "Ссылки на"
+
+msgid "Expand for references to"
+msgstr "Раскрыть ссылки на"

sphinx_codeautolink-0.17.2/src/sphinx_codeautolink/locale/uk/LC_MESSAGES/sphinx-codeautolink.po

@@ -0,0 +1,25 @@
+# Ukrainian translations for sphinx-codeautolink.
+# Copyright (C) 2025 ORGANIZATION
+# This file is distributed under the same license as the sphinx-codeautolink project.
+# Yuriy Skalko <yuriy.skalko@gmail.com>, 2025.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: 1\n"
+"Report-Msgid-Bugs-To: yuriy.skalko@gmail.com\n"
+"POT-Creation-Date: 2025-02-24 17:30+0200\n"
+"PO-Revision-Date: 2025-02-24 18:42+0100\n"
+"Last-Translator: Yuriy Skalko <yuriy.skalko@gmail.com>\n"
+"Language: uk\n"
+"Language-Team: Yuriy Skalko <yuriy.skalko@gmail.com>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.17.0\n"
+
+msgid "References to"
+msgstr "Посилання на"
+
+msgid "Expand for references to"
+msgstr "Розгорнути посилання на"

{sphinx_codeautolink-0.17.1 → sphinx_codeautolink-0.17.2/src/sphinx_codeautolink.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: sphinx-codeautolink
-Version: 0.17.1
+Version: 0.17.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>

{sphinx_codeautolink-0.17.1 → sphinx_codeautolink-0.17.2}/src/sphinx_codeautolink.egg-info/SOURCES.txt

@@ -42,8 +42,14 @@ src/sphinx_codeautolink/locale/es/LC_MESSAGES/sphinx-codeautolink.mo
 src/sphinx_codeautolink/locale/es/LC_MESSAGES/sphinx-codeautolink.po
 src/sphinx_codeautolink/locale/fi/LC_MESSAGES/sphinx-codeautolink.mo
 src/sphinx_codeautolink/locale/fi/LC_MESSAGES/sphinx-codeautolink.po
+src/sphinx_codeautolink/locale/fr/LC_MESSAGES/sphinx-codeautolink.mo
+src/sphinx_codeautolink/locale/fr/LC_MESSAGES/sphinx-codeautolink.po
 src/sphinx_codeautolink/locale/it/LC_MESSAGES/sphinx-codeautolink.mo
 src/sphinx_codeautolink/locale/it/LC_MESSAGES/sphinx-codeautolink.po
+src/sphinx_codeautolink/locale/nl/LC_MESSAGES/sphinx-codeautolink.mo
+src/sphinx_codeautolink/locale/nl/LC_MESSAGES/sphinx-codeautolink.po
+src/sphinx_codeautolink/locale/ru/LC_MESSAGES/sphinx-codeautolink.po
+src/sphinx_codeautolink/locale/uk/LC_MESSAGES/sphinx-codeautolink.po
 src/sphinx_codeautolink/static/sphinx-codeautolink.css
 tests/__init__.py
 tests/extension/__init__.py
@@ -83,6 +89,8 @@ tests/extension/ref/lexer_default_fail.txt
 tests/extension/ref/lexer_doctest.txt
 tests/extension/ref/lexer_doctest_empty_input.txt
 tests/extension/ref/lexer_extdoctest_doctest.txt
+tests/extension/ref/lexer_extdoctest_setup.txt
+tests/extension/ref/lexer_extdoctest_setup_wrong.txt
 tests/extension/ref/lexer_extdoctest_testcode.txt
 tests/extension/ref/lexer_highlight_language.txt
 tests/extension/ref/lexer_highlight_none.txt

{sphinx_codeautolink-0.17.1 → sphinx_codeautolink-0.17.2}/tests/extension/ref/lexer_extdoctest_doctest.txt

@@ -4,10 +4,7 @@ attr
 test_project.Foo
 test_project.Foo
 # split
-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.17.2/tests/extension/ref/lexer_extdoctest_setup.txt

@@ -0,0 +1,35 @@
+test_project.bar
+tp.bar
+test.Foo
+# split
+extensions.append("sphinx.ext.doctest")
+# split
+Test project
+============
+
+.. testsetup::
+
+    import test_project
+
+.. doctest::
+
+    >>> test_project.bar()
+
+.. testsetup:: *
+
+.. doctest::
+
+    >>> test_project.Foo()
+
+.. testsetup:: thisgroup
+
+   import test_project as tp
+
+   import test_project as test
+
+.. doctest:: thisgroup
+
+    >>> tp.bar()
+    >>> test.Foo()
+
+.. automodule:: test_project

sphinx_codeautolink-0.17.2/tests/extension/ref/lexer_extdoctest_setup_wrong.txt

@@ -0,0 +1,15 @@
+# split
+extensions.append("sphinx.ext.doctest")
+# split
+Test project
+============
+
+.. testsetup:: specificgroup
+
+    import test_project
+
+.. doctest::
+
+    >>> test_project.bar()
+
+.. automodule:: test_project

{sphinx_codeautolink-0.17.1 → sphinx_codeautolink-0.17.2}/tests/extension/ref/lexer_extdoctest_testcode.txt

@@ -5,7 +5,6 @@ test_project.Foo
 test_project.Foo
 # split
 extensions.append("sphinx.ext.doctest")
-codeautolink_custom_blocks = {"python3": None}
 # split
 Test project
 ============