Update doctests

Author: apriha

.github/workflows/ci.yml

@@ -100,7 +100,7 @@ jobs:
         fi
     - name: Install dependencies
       run: |
-        pip install pytest-cov
+        pip install pytest-cov sybil
         pip install .
     - name: Ensure Python and source code are on same drive (Windows)
       if: ${{ matrix.os == 'windows-latest' }}
@@ -111,12 +111,12 @@ jobs:
     - name: Test with pytest (Ubuntu & macOS)
       if: ${{ matrix.os != 'windows-latest' }}
       run: |
-        pytest --cov=lineage tests
+        pytest --cov=lineage tests README.md
     - name: Test with pytest (Windows)
       if: ${{ matrix.os == 'windows-latest' }}
       working-directory: C:\a\lineage\lineage
       run: |
-        pytest --cov=lineage tests
+        pytest --cov=lineage tests README.md
     - name: Upload coverage to Codecov (Ubuntu & macOS)
       if: ${{ matrix.os != 'windows-latest' }}
       uses: codecov/codecov-action@v5

.vscode/tasks.json

@@ -4,7 +4,7 @@
         {
             "label": "Run All Tests",
             "type": "shell",
-            "command": "source .venv/bin/activate && python -m pytest tests README.rst",
+            "command": "source .venv/bin/activate && python -m pytest tests README.md",
             "group": {
                 "kind": "test",
                 "isDefault": true
@@ -18,7 +18,7 @@
         {
             "label": "Test README Examples",
             "type": "shell",
-            "command": "source .venv/bin/activate && python -m doctest README.rst -v",
+            "command": "source .venv/bin/activate && python -m pytest README.md -v",
             "group": "test",
             "presentation": {
                 "reveal": "always",

CONTRIBUTING.md

@@ -56,7 +56,7 @@ To set up `lineage` for local development:
 5. When you're done making changes, run all the tests with:
 
    ```
-   $ pipenv run pytest --cov-report=html --cov=lineage tests
+   $ pipenv run pytest --cov-report=html --cov=lineage tests README.md
    ```
 
    :::{note}

Pipfile

@@ -9,6 +9,7 @@ pytest-cov = "*"
 sphinx = "*"
 sphinx-rtd-theme = "*"
 ruff = "*"
+sybil = "*"
 
 [packages]
 lineage = {editable = true,path = "."}

conftest.py

@@ -0,0 +1,19 @@
+"""
+Pytest configuration for testing code examples in README.md using Sybil.
+
+This conftest.py enables Sybil to parse and test Python code blocks in the
+README.md file as part of the pytest test suite. The PythonCodeBlockParser
+evaluates fenced Python code blocks (```python), while SkipParser allows
+selective skipping of examples using Markdown comments when needed.
+"""
+
+from sybil import Sybil
+from sybil.parsers.markdown import PythonCodeBlockParser, SkipParser
+
+pytest_collect_file = Sybil(
+    parsers=[
+        PythonCodeBlockParser(),
+        SkipParser(),
+    ],
+    patterns=["README.md"],
+).pytest()

setup.cfg

@@ -19,7 +19,7 @@ addopts =
     -ra
     --strict
     --tb=short
-    --doctest-glob=README.md
+    -p no:doctest
 
 # http://coverage.readthedocs.io/en/latest/
 [coverage:run]