Merge pull request #243 from adamtheturtle/inherit-pdf

Inherit from PDF library

Author: adamtheturtle

.github/workflows/ci.yml

@@ -33,7 +33,7 @@ jobs:
 
       - name: Build sample
         run: |
-          uv run --extra=sample --python=${{ matrix.python-version }} sphinx-build -W -b notion sample/ build-sample/
+          uv run --python=${{ matrix.python-version }} sphinx-build -W -b notion sample/ build-sample/
 
       - name: Run lint
         run: |

.github/workflows/publish-notion.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Build documentation
         run: |
           rm -rf ./build-sample
-          uv run --extra=sample sphinx-build -W -b notion sample ./build-sample
+          uv run sphinx-build -W -b notion sample ./build-sample
 
       - name: Publish to Notion
         run: |

.pre-commit-config.yaml

@@ -301,7 +301,7 @@ repos:
 
       - id: linkcheck
         name: linkcheck
-        entry: uv run --extra=sample sphinx-build -W -b linkcheck sample build-sample/
+        entry: uv run sphinx-build -W -b linkcheck sample build-sample/
         language: python
         types_or: [rst]
         stages: [manual]
@@ -310,7 +310,7 @@ repos:
 
       - id: spelling
         name: spelling
-        entry: uv run --extra=sample sphinx-build -W -b spelling sample build-sample/
+        entry: uv run sphinx-build -W -b spelling sample build-sample/
         language: python
         types_or: [rst]
         stages: [manual]
@@ -319,15 +319,15 @@ repos:
 
       - id: docs
         name: Build Documentation
-        entry: uv run --extra=sample sphinx-build -W -b notion sample build-sample/notion
+        entry: uv run sphinx-build -W -b notion sample build-sample/notion
         language: python
         stages: [manual]
         pass_filenames: false
         additional_dependencies: [uv==0.6.3]
 
       - id: docs-as-html
         name: Build Documentation as HTML
-        entry: uv run --extra=sample sphinx-build -W -b html sample build-sample/html
+        entry: uv run sphinx-build -W -b html sample build-sample/html
         language: python
         stages: [manual]
         pass_filenames: false

README.rst

@@ -117,23 +117,6 @@ PDF files can be embedded using the ``pdf-include`` directive. Both remote URLs
 
 The PDF will be rendered as an embedded PDF viewer in the generated Notion page.
 
-To make this work in HTML output, you need to install the sphinx-simplepdf extension:
-
-.. code-block:: console
-
-   $ pip install sphinx-simplepdf
-
-and add it to your ``conf.py`` file:
-
-.. code-block:: python
-
-   """Configuration for Sphinx."""
-
-   extensions = [
-       "sphinx_simplepdf",
-       "sphinx_notion",
-   ]
-
 Uploading Documentation to Notion
 ----------------------------------
 

pyproject.toml

@@ -36,6 +36,7 @@ dependencies = [
     "click>=8.0.0",
     "docutils>=0.21",
     "sphinx>=8.2.3",
+    "sphinx-simplepdf>=1.6.0",
     "sphinx-toolbox>=4.0.0",
     "sphinxcontrib-video>=0.4.0",
     "sphinxnotes-strike>=1.3",
@@ -79,10 +80,6 @@ optional-dependencies.dev = [
     "yamlfix==1.18.0",
 ]
 optional-dependencies.release = [ "check-wheel-contents==0.6.3" ]
-optional-dependencies.sample = [
-    # Needed for PDF support in the sample for HTML only.
-    "sphinx-simplepdf==1.6.0",
-]
 urls.Source = "https://github.com/adamtheturtle/sphinx-notionbuilder"
 
 scripts.notion-upload = "_notion_scripts.upload:main"

src/sphinx_notion/__init__.py

@@ -3,11 +3,10 @@
 """
 
 import json
-from collections.abc import Callable
 from dataclasses import dataclass
 from functools import singledispatch
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, ClassVar
+from typing import Any
 
 import sphinxnotes.strike
 from atsphinx.audioplayer.nodes import (  # pyright: ignore[reportMissingTypeStubs]
@@ -16,11 +15,13 @@
 from beartype import beartype
 from docutils import nodes
 from docutils.nodes import NodeVisitor
-from docutils.parsers.rst import Directive, directives
 from sphinx.application import Sphinx
 from sphinx.builders.text import TextBuilder
 from sphinx.util import docutils as sphinx_docutils
 from sphinx.util.typing import ExtensionMetadata
+from sphinx_simplepdf.directives.pdfinclude import (  # pyright: ignore[reportMissingTypeStubs]
+    PdfIncludeDirective,
+)
 from sphinx_toolbox.collapse import CollapseNode
 from sphinxcontrib.video import (  # pyright: ignore[reportMissingTypeStubs]
     video_node,
@@ -63,9 +64,6 @@
 from ultimate_notion.obj_api.enums import BGColor, CodeLang
 from ultimate_notion.rich_text import Text, text
 
-if TYPE_CHECKING:
-    from _typeshed import Incomplete
-
 
 @beartype
 def _serialize_block_with_children(
@@ -87,30 +85,19 @@ def _serialize_block_with_children(
 
 
 @beartype
-class _PdfNode(nodes.Element):
+class _PdfNode(nodes.raw):  # pylint: disable=too-many-ancestors
     """
     Custom PDF node for Notion PDF blocks.
     """
 
 
 @beartype
-class _NotionPdfIncludeDirective(Directive):
+class _NotionPdfIncludeDirective(PdfIncludeDirective):
     """
     PDF include directive that creates Notion PDF blocks.
     """
 
-    has_content = False
-    required_arguments = 1
-    optional_arguments = 0
-    final_argument_whitespace = True
-    option_spec: ClassVar[dict[str, Callable[[str], "Incomplete"]] | None] = {
-        "width": directives.length_or_percentage_or_unitless,
-        "height": directives.length_or_percentage_or_unitless,
-        "page": directives.positive_int,
-        "toolbar": directives.nonnegative_int,
-    }
-
-    def run(self) -> list[_PdfNode]:
+    def run(self) -> list[nodes.raw]:
         """
         Create a Notion PDF block.
         """