Merge pull request #72 from adamtheturtle/lint-ci

Run linters (e.g. in CI)

Author: adamtheturtle

.github/workflows/ci.yml

@@ -35,6 +35,12 @@ jobs:
         run: |
           uv run --extra=dev --python=${{ matrix.python-version }} sphinx-build -b notion sample/ build-sample/
 
+      - name: Run lint
+        run: |
+          uv run --extra=dev --python=${{ matrix.python-version }} pre-commit run --all-files --hook-stage pre-commit --verbose
+          uv run --extra=dev --python=${{ matrix.python-version }} pre-commit run --all-files --hook-stage pre-push --verbose
+          uv run --extra=dev --python=${{ matrix.python-version }} pre-commit run --all-files --hook-stage manual --verbose
+
       - name: Run tests
         run: |
           # We run tests against "." and not the tests directory as we test the README

.pre-commit-config.yaml

@@ -191,7 +191,7 @@ repos:
 
       - id: pylint
         name: pylint
-        entry: uv run --extra=dev -m pylint *.py src/ tests/ docs/
+        entry: uv run --extra=dev -m pylint src/ tests/ sample/
         language: python
         stages: [manual]
         pass_filenames: false
@@ -265,7 +265,7 @@ repos:
 
       - id: linkcheck
         name: linkcheck
-        entry: make -C docs/ linkcheck SPHINXOPTS=-W
+        entry: uv run sphinx-build -W -b linkcheck sample build-sample/
         language: python
         types_or: [rst]
         stages: [manual]
@@ -274,7 +274,7 @@ repos:
 
       - id: spelling
         name: spelling
-        entry: make -C docs/ spelling SPHINXOPTS=-W
+        entry: uv run sphinx-build -W -b spelling sample build-sample/
         language: python
         types_or: [rst]
         stages: [manual]
@@ -283,7 +283,7 @@ repos:
 
       - id: docs
         name: Build Documentation
-        entry: make docs
+        entry: uv run sphinx-build -W -b notion sample build-sample/
         language: python
         stages: [manual]
         pass_filenames: false

sample/index.rst

@@ -8,16 +8,16 @@ Some text with a link to `Google <https://google.com>`_ and `<https://example.co
 This is **bold** and *italic* and ``inline code``.
 
 .. note::
+
    This is an important note that demonstrates the note admonition support.
-   It will be converted to a Notion callout block with a note emoji.
 
 .. warning::
+
    This is a warning that demonstrates the warning admonition support.
-   It will be converted to a Notion callout block with a warning emoji and yellow background.
 
 .. tip::
+
    This is a helpful tip that demonstrates the tip admonition support.
-   It will be converted to a Notion callout block with a lightbulb emoji and green background.
 
 .. code-block:: python
 
@@ -58,6 +58,6 @@ Heading 3 with ``inline code``
 
 Regular paragraph.
 
-    This is a multiline
+    This is a multi-line
     block quote with
     multiple lines.

spelling_private_dict.txt

@@ -0,0 +1,10 @@
+backtick
+backticks
+callout
+href
+pragma
+preprocess
+pyright
+recurse
+reportUnknownMemberType
+reportUnknownVariableType