chore: Update project template to sphinx-notes/cookiecutter@4c6b17ae

Author: SilverRainZ

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/sphinx-notes/cookiecutter",
-  "commit": "158e67b1043bf95237e70c4ffffbda02dffc4886",
+  "commit": "4c6b17aec1a4b8ddca95c4882c6bed2bc230d595",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -20,7 +20,7 @@
       "sphinx_version": "7.0",
       "development_status": "3 - Alpha",
       "_template": "https://github.com/sphinx-notes/cookiecutter",
-      "_commit": "158e67b1043bf95237e70c4ffffbda02dffc4886"
+      "_commit": "4c6b17aec1a4b8ddca95c4882c6bed2bc230d595"
     }
   },
   "directory": null

.github/workflows/test.yml

@@ -12,5 +12,14 @@ jobs:
     - uses: actions/setup-python@v5
       with:
         python-version-file: 'pyproject.toml'
-    - run: python3 -m pip install .[dev]
+    - run: python3 -m pip install .[test]
     - run: make test
+  doctest:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v5
+      with:
+        python-version-file: 'pyproject.toml'
+    - run: python3 -m pip install .[docs]
+    - run: make doctest

Makefile

@@ -27,7 +27,11 @@ fmt:
 
 .PHONY: test
 test:
-	$(PY) -m unittest discover -s tests -v
+	$(PY) -m pytest tests/ -v
+
+.PHONY: doctest
+doctest:
+	$(MAKE) doctest -C docs/
 
 ################################################################################
 # Distribution Package
@@ -36,7 +40,8 @@ test:
 # Build distribution package, for "install" or "upload".
 .PHONY: dist
 dist: pyproject.toml clean
-	$(PY) -m build
+	# Use ``--no-isolation`` to prevent network accessing when in local env.
+	$(PY) -m build $(if $(CI),,--no-isolation)
 
 # Install distribution package to user directory.
 #

docs/conf.py

@@ -23,6 +23,8 @@
 # ones.
 extensions = [
     'sphinx.ext.githubpages',
+    'sphinx.ext.doctest',
+    'sphinx.ext.viewcode',
     'sphinx_design',
     'sphinx_copybutton',
     'sphinx_last_updated_by_git',
@@ -114,8 +116,8 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../src/sphinxnotes'))
-extensions.append('project')
+sys.path.insert(0, os.path.abspath('../src/'))
+extensions.append('sphinxnotes.project')
 
 # CUSTOM CONFIGURATION
 primary_domain = 'any'

tests/test_always_pass.py

@@ -0,0 +1,9 @@
+# This file is generated from sphinx-notes/cookiecutter.
+# DO NOT EDIT.
+
+import unittest
+
+
+class TestAlwaysPass(unittest.TestCase):
+    def test_dummy(self):
+        self.assertTrue(True)