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

Author: SilverRainZ

.cruft.json

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

.github/workflows/test.yml

@@ -0,0 +1,16 @@
+name: Test
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 7 * * 6'
+jobs:
+  test:
+    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 .[dev]
+    - run: make test

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.1
+    rev: v0.14.11
     hooks:
       - id: ruff-check
         args: [ --fix ]

Makefile

@@ -23,7 +23,7 @@ clean:
 
 .PHONY: fmt
 fmt:
-	ruff format src/ && ruff check --fix src/
+	ruff format src/ tests/ && ruff check --fix src/ tests/
 
 .PHONY: test
 test:
@@ -36,7 +36,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.
+	$(PY) -m build --no-isolation
 
 # Install distribution package to user directory.
 #

docs/_static/custom.css

@@ -0,0 +1,10 @@
+/* This file is generated from sphinx-notes/cookiecutter.
+ * DO NOT EDIT.
+ */
+
+/* Missing style for nodes.system_message from Alabaster. */
+.system-message {
+    background-color: #fda;
+    padding: 5px;
+    border: 3px solid red;
+}

docs/conf.py

@@ -45,19 +45,16 @@
 # produce any output in the built files.
 show_authors = True
 
+# Keep warnings as “system message” paragraphs in the rendered documents.
+keep_warnings = True
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
 html_theme = 'furo'
 
-html_theme_options = {}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
 html_theme_options = {
     "source_repository": "https://github.com/sphinx-notes/isso/",
     "source_branch": "master",
@@ -70,6 +67,13 @@
 
 html_logo = html_favicon = '_static/sphinx-notes.png'
 
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+html_css_files = ['custom.css']
+
 # -- Extensions -------------------------------------------------------------
 
 extensions.append('sphinx.ext.extlinks')
@@ -87,11 +91,7 @@
 autodoc_typehints = 'description'
 
 extensions.append('sphinx.ext.intersphinx')
-intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None),
-    'sphinx': ('https://www.sphinx-doc.org/en/master', None),
-    'jinja': ('https://jinja.palletsprojects.com/en/latest/', None),
-}
+intersphinx_mapping = {}
 
 extensions.append('sphinx_sitemap')
 sitemap_filename = "sitemap.xml"

docs/index.rst

@@ -120,6 +120,7 @@ as part of **The Sphinx Notes Project**.
    :caption: The Sphinx Notes Project
 
    Home <https://sphinx.silverrainz.me/>
+   GitHub <https://github.com/sphinx-notes>
    Blog <https://silverrainz.me/blog/category/sphinx.html>
    PyPI <https://pypi.org/search/?q=sphinxnotes>
 

src/sphinxnotes/isso/meta.py

@@ -8,6 +8,10 @@
 from __future__ import annotations
 from importlib import metadata
 
+from sphinx.application import Sphinx
+from sphinx.util.typing import ExtensionMetadata
+
+
 __project__ = 'sphinxnotes-isso'
 __author__ = 'Shengyu Zhang'
 __desc__ = 'Sphinx extension for embeding Isso comments in documents'
@@ -23,11 +27,11 @@
 ################################################################################
 
 
-def pre_setup(app):
+def pre_setup(app: Sphinx) -> None:
     app.require_sphinx('7.0')
 
 
-def post_setup(app):
+def post_setup(app: Sphinx) -> ExtensionMetadata:
     return {
         'version': __version__,
         'parallel_read_safe': True,