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

Author: SilverRainZ

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/sphinx-notes/cookiecutter",
-  "commit": "7e07548aad55432b86d881ccdab66eb1c89986c0",
+  "commit": "7cadd39d13e7e95f37aecb9e998f4d7bb66dbf10",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -14,8 +14,13 @@
       "github_repo": "comboroles",
       "pypi_name": "sphinxnotes-comboroles",
       "pypi_owner": "SilverRainZ",
+      "is_python_project": true,
+      "python_version": "3.12",
+      "is_sphinx_extension": true,
+      "sphinx_version": "7.0",
+      "development_status": "3 - Alpha",
       "_template": "https://github.com/sphinx-notes/cookiecutter",
-      "_commit": "7e07548aad55432b86d881ccdab66eb1c89986c0"
+      "_commit": "7cadd39d13e7e95f37aecb9e998f4d7bb66dbf10"
     }
   },
   "directory": null

.github/workflows/pages.yml

@@ -13,7 +13,7 @@ concurrency:
 
 jobs:
   pages:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}

.pre-commit-config.yaml

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

Makefile

@@ -9,30 +9,30 @@ RM    = rm -rf
 GIT   = git
 OPEN  = xdg-open
 
-# Build sphinx documentation.
 .PHONY: docs
 docs:
 	$(MAKE) -C docs/
 
-# View sphinx HTML documentation in browser.
-.PHONY: view
+.PHONY:
 view:
 	$(OPEN) docs/_build/html/index.html
 
 .PHONY: clean
 clean:
-	$(MAKE) -C docs/ clean | true
-	$(RM) dist/ | true
+	$(MAKE) -C docs/ clean; $(RM) dist/
 
-.PHONY: clean
+.PHONY: fmt
 fmt:
-	ruff format src/
+	ruff format src/ && ruff check --fix src/
 
-# Run unittest.
 .PHONY: test
 test:
 	$(PY) -m unittest discover -s tests -v
 
+################################################################################
+# Distribution Package
+################################################################################
+
 # Build distribution package, for "install" or "upload".
 .PHONY: dist
 dist: pyproject.toml clean
@@ -54,28 +54,37 @@ install: dist
 upload: dist
 	$(PY) -m twine upload --repository pypi $</*
 
-# Same to the aboved "upload" target, but this publishs to PyPI test server
-# <https://test.pypi.org/>.
-.PHONY: upload-test
-upload-test: dist
-	$(PY) -m twine upload --repository testpypi $</*
+################################################################################
+# Cookiecutter Incremental Updates
+################################################################################
 
 # Keep up to date with the latest template.
-# See also https://github.com/sphinx-notes/cookiecutter.
-.PHONY: update-template
-update-template:
+# See https://github.com/sphinx-notes/cookiecutter.
+.PHONY: tmpl-update
+tmpl-update:
 	$(PY) -m cruft update
 
-.PHONY: update-template-done
-update-template-done:
+.PHONY: tmpl-update-done
+tmpl-update-done:
 	$(GIT) commit -m "chore: Update project template to sphinx-notes/cookiecutter@$(shell jq -r '.commit' .cruft.json | head -c8)"
 
+.PHONY: apply-rej
+apply-rej:
+	@for rej in $$(find . -name '*.rej'); do \
+		echo "applying $$rej..."; \
+		wiggle --replace $${rej%.rej} $$rej; \
+	done
+
+# Detect the minimum Python versions needed to run code.
+pyvermin:
+	vermin --eval-annotations --target=3.12- --versions src/
+
 # Update project version.
 .PHONY: bump-version
 bump-version:
 	@echo -n "Please enter the version to bump: "
 	@read version && $(PY) -m cruft update --variables-to-update "{ \"version\" : \"$$version\" }"
 
-# EXTRA TARGETS START
-
-# EXTRA TARGETS END
+################################################################################
+# CUSTOM TARGETS
+################################################################################

README.rst

@@ -8,15 +8,12 @@ sphinxnotes-comboroles
 .. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/comboroles/github-pages
    :target: https://sphinx.silverrainz.me/comboroles
    :alt: Documentation Status
-
 .. |license| image:: https://img.shields.io/github/license/sphinx-notes/comboroles
    :target: https://github.com/sphinx-notes/comboroles/blob/master/LICENSE
    :alt: Open Source License
-
 .. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-comboroles.svg
    :target: https://pypi.python.org/pypi/sphinxnotes-comboroles
    :alt: PyPI Package
-
 .. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-comboroles
    :target: https://pypi.python.org/pypi/sphinxnotes-comboroles
    :alt: PyPI Package Downloads

docs/conf.py

@@ -7,9 +7,6 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-import os
-import sys
-
 # -- Project information -----------------------------------------------------
 
 project = 'sphinxnotes-comboroles'
@@ -28,6 +25,7 @@
     'sphinx.ext.githubpages',
     'sphinx_design',
     'sphinx_copybutton',
+    'sphinx_last_updated_by_git',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -95,6 +93,15 @@
     'jinja': ('https://jinja.palletsprojects.com/en/latest/', None),
 }
 
+extensions.append('sphinx_sitemap')
+sitemap_filename = "sitemap.xml"
+sitemap_url_scheme = "{link}"
+
+extensions.append('sphinxext.opengraph')
+ogp_site_url = html_baseurl
+ogp_site_name = project
+ogp_image = html_baseurl + '/' + html_logo
+
 extensions.append('sphinxnotes.project')
 primary_domain = 'any'
 
@@ -103,11 +110,17 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # 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('comboroles')
 
 # DOG FOOD CONFIGURATION START
 
+# DOG FOOD CONFIGURATION END
+
+# CUSTOM CONFIGURATION
+
 comboroles_roles = {
     # bulitin.
     'strong_literal': ['strong', 'literal'],
@@ -126,10 +139,3 @@
 }
 
 extensions.append('sphinxnotes.strike')
-
-extensions.append('sphinx.ext.intersphinx')
-
-# For role strong_pycls.
-intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
-
-# DOG FOOD CONFIGURATION END

docs/index.rst

@@ -5,23 +5,23 @@
 sphinxnotes-comboroles
 ======================
 
-.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/comboroles/github-pages
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/comboroles/github-pages?label=docs
    :target: https://sphinx.silverrainz.me/comboroles
    :alt: Documentation Status
-
 .. |license| image:: https://img.shields.io/github/license/sphinx-notes/comboroles
    :target: https://github.com/sphinx-notes/comboroles/blob/master/LICENSE
    :alt: Open Source License
-
 .. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-comboroles.svg
    :target: https://pypi.python.org/pypi/sphinxnotes-comboroles
    :alt: PyPI Package
-
 .. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-comboroles
    :target: https://pypi.python.org/pypi/sphinxnotes-comboroles
    :alt: PyPI Package Downloads
+.. |github| image:: https://img.shields.io/badge/GitHub-181717?style=flat&logo=github&logoColor=white/
+   :target: https://github.com/sphinx-notes/comboroles
+   :alt: GitHub Repository
 
-|docs| |license| |pypi| |download|
+|docs| |license| |pypi| |download| |github|
 
 .. _intro:
 
@@ -55,12 +55,14 @@ Getting Started
    We assume you already have a Sphinx documentation,
    if not, see `Getting Started with Sphinx`_.
 
+
 First, downloading extension from PyPI:
 
 .. code-block:: console
 
    $ pip install sphinxnotes-comboroles
 
+
 Then, add the extension name to ``extensions`` configuration item in your
 :parsed_literal:`conf.py_`:
 

pyproject.toml

@@ -9,26 +9,41 @@
 name = "sphinxnotes-comboroles"
 description = "Sphinx extension for composing multiple roles"
 readme = "README.rst"
-license = { file = "BSD-3-Clause" }
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
 authors = [ { name = "Shengyu Zhang" } ]
 maintainers = [ { name = "Shengyu Zhang" } ]
-keywords = ["sphinx", "extension", "documentation"] # TOOD: additional_keywords
+keywords = [
+    "sphinx",
+    "extension",
+    "documentation",
+    "sphinxnotes",
+
+    # CUSTOM KEYWORDS START
+    # CUSTOM KEYWORDS END
+]
 classifiers = [
-    # "Development Status :: 4 - Beta",
+    "Development Status :: 3 - Alpha",
     "Environment :: Plugins",
     "Framework :: Sphinx",
     "Framework :: Sphinx :: Extension",
-    "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Topic :: Documentation",
     "Topic :: Documentation :: Sphinx",
+
+    # CUSTOM CLASSIFIERS START
+    # CUSTOM CLASSIFIERS END
 ]
 
-requires-python = ">=3.8"
+# See ``make pyver`` for more details.
+requires-python = ">=3.12"
 dependencies = [
-    "Sphinx >= 4",
+    "Sphinx >= 7.0",
+
+    # CUSTOM DEPENDENCIES START
+    # CUSTOM DEPENDENCIES END
 ]
 
 dynamic = ["version"] # required by setuptools_scm, see section [build-system]
@@ -39,18 +54,27 @@ dev = [
     "twine",
     "cruft",
     "ruff",
-    "pre-commit"
+    "pre-commit",
+    "vermin",
 ]
 test = [
     "pytest",
 ]
 docs = [
     "furo",
-    "sphinxnotes-project",
     "sphinx_design",
     "sphinx_copybutton",
     "sphinxcontrib-gtagjs",
+    "sphinx-sitemap",
+    "sphinxext-opengraph",
+    "sphinx-last-updated-by-git",
+
+    # Dependencies of sphinxnotes projcts.
+    "sphinxnotes-project",
+
+    # CUSTOM DOCS DEPENDENCIES START
     "sphinxnotes-strike",
+    # CUSTOM DOCS DEPENDENCIES END
 ]
 
 [project.urls]
@@ -73,3 +97,5 @@ version_scheme = "no-guess-dev"
 # Find namespace package,
 # check out https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#finding-namespace-packages
 where = ["src"]
+
+# CUSTOM CONFIGURATION

ruff.toml

@@ -7,3 +7,8 @@ exclude = [
 
 [format]
 quote-style = "single"
+
+[lint]
+ignore = [
+    "E741", # Checks for the use of the characters 'l', 'O', or 'I' as variable names
+]

src/sphinxnotes/comboroles/meta.py

@@ -0,0 +1,35 @@
+# This file is generated from sphinx-notes/cookiecutter.
+# DO NOT EDIT!!!
+
+################################################################################
+# Project meta infos.
+################################################################################
+
+from __future__ import annotations
+from importlib import metadata
+
+__project__ = 'sphinxnotes-comboroles'
+__author__ = 'Shengyu Zhang'
+__desc__ = 'Sphinx extension for composing multiple roles'
+
+try:
+    __version__ = metadata.version('sphinxnotes-comboroles')
+except metadata.PackageNotFoundError:
+    __version__ = 'unknown'
+
+
+################################################################################
+# Sphinx extension utils.
+################################################################################
+
+
+def pre_setup(app):
+    app.require_sphinx('7.0')
+
+
+def post_setup(app):
+    return {
+        'version': __version__,
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }