Merge pull request #223 from adamtheturtle/strike-no-prerelease

Remove requirement to have a pre-release dependency

Author: adamtheturtle

pyproject.toml

@@ -37,7 +37,7 @@ dependencies = [
     "sphinx>=8.2.3",
     "sphinx-toolbox>=4.0.0",
     "sphinxcontrib-video>=0.4.0",
-    "sphinxnotes-strike>=1.3a1",
+    "sphinxnotes-strike>=1.2.1",
     "ultimate-notion>=0.9.2",
 ]
 optional-dependencies.dev = [

src/sphinx_notion/__init__.py

@@ -8,18 +8,25 @@
 from pathlib import Path
 from typing import Any
 
-import sphinxnotes.strike
+# Wait for ``sphinxnotes-strike`` to release a version with type stubs.
+import sphinxnotes.strike  # pyright: ignore[reportMissingTypeStubs]
 from beartype import beartype
 from docutils import nodes
 from docutils.nodes import NodeVisitor
+from docutils.parsers.rst.states import Inliner
+from docutils.utils import unescape
 from sphinx.application import Sphinx
 from sphinx.builders.text import TextBuilder
 from sphinx.util.typing import ExtensionMetadata
 from sphinx_toolbox.collapse import CollapseNode
 from sphinxcontrib.video import (  # pyright: ignore[reportMissingTypeStubs]
     video_node,
 )
-from sphinxnotes.strike import strike_node
+
+# Wait for ``sphinxnotes-strike`` to release a version with type stubs.
+from sphinxnotes.strike import (  # pyright: ignore[reportMissingTypeStubs]
+    strike_node,
+)
 from ultimate_notion import Emoji
 from ultimate_notion.blocks import Block, ChildrenMixin
 from ultimate_notion.blocks import BulletedItem as UnoBulletedItem
@@ -1128,6 +1135,31 @@ def _depart_video_node_notion(
     del node
 
 
+@beartype
+def _override_strike_role(  # pylint: disable=too-many-positional-arguments
+    typ: str,
+    rawtext: str,
+    text: str,  # pylint: disable=redefined-outer-name
+    lineno: int,
+    inliner: Inliner,
+    options: dict[Any, Any] | None = None,
+    content: list[str] | None = None,
+) -> tuple[list[nodes.Node], list[nodes.system_message]]:
+    """The ``sphinxnotes-strike`` extension's ``strike_role`` is overridden to
+    process strike nodes into Notion blocks.
+
+    This will not be needed after ``sphinxnotes-strike`` 1.3 is released.
+    """
+    del typ
+    del lineno
+    del options
+    del content
+    env = inliner.document.settings.env
+    node = strike_node(rawtext, unescape(text=text))
+    node["docname"] = env.docname
+    return [node], []
+
+
 @beartype
 def setup(app: Sphinx) -> ExtensionMetadata:
     """
@@ -1141,5 +1173,10 @@ def setup(app: Sphinx) -> ExtensionMetadata:
         notion=(_visit_video_node_notion, _depart_video_node_notion),
         override=True,
     )
-    sphinxnotes.strike.SUPPORTED_BUILDERS.append(NotionBuilder)
+
+    # After ``sphinxnotes-strike`` is updated to have a ``SUPPORTED_BUILDERS``
+    # attribute, we can remove this and use the default ``strike_role``,
+    # and append ``NotionBuilder`` to ``SUPPORTED_BUILDERS``.
+    sphinxnotes.strike.strike_role = _override_strike_role
+    assert sphinxnotes.strike.strike_role is not None
     return {"parallel_read_safe": True}