Merge pull request #238 from adamtheturtle/add-pdf

Try to fix sample build

Author: adamtheturtle

.gitattributes

@@ -1,3 +1,4 @@
+*.pdf filter=lfs diff=lfs merge=lfs -text
 *.png filter=lfs diff=lfs merge=lfs -text
 *.jpg filter=lfs diff=lfs merge=lfs -text
 *.jpeg filter=lfs diff=lfs merge=lfs -text

.github/workflows/ci.yml

@@ -33,7 +33,7 @@ jobs:
 
       - name: Build sample
         run: |
-          uv run --extra=dev --python=${{ matrix.python-version }} sphinx-build -W -b notion sample/ build-sample/
+          uv run --extra=sample --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 sphinx-build -W -b notion sample ./build-sample
+          uv run --extra=sample 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 sphinx-build -W -b linkcheck sample build-sample/
+        entry: uv run --extra=sample 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 sphinx-build -W -b spelling sample build-sample/
+        entry: uv run --extra=sample 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 sphinx-build -W -b notion sample build-sample/notion
+        entry: uv run --extra=sample 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 sphinx-build -W -b html sample build-sample/html
+        entry: uv run --extra=sample sphinx-build -W -b html sample build-sample/html
         language: python
         stages: [manual]
         pass_filenames: false

pyproject.toml

@@ -72,14 +72,17 @@ optional-dependencies.dev = [
     "shfmt-py==3.12.0.2",
     "sphinx-lint==1.0.0",
     "sphinx-pyproject==0.3.0",
-    "sphinx-simplepdf==1.6.0",
     "sphinx-substitution-extensions==2025.6.6",
     "sphinxcontrib-spelling==8.0.1",
     "types-docutils==0.22.2.20250924",
     "vulture==2.14",
     "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"
@@ -315,6 +318,7 @@ ignore = [
 pep621_dev_dependency_groups = [
     "dev",
     "release",
+    "sample",
 ]
 
 [tool.pyproject-fmt]