chore: Update cookiecutter tempalte

Author: SilverRainZ

.cruft.json

@@ -1,6 +1,6 @@
 {
  "template": "https://github.com/sphinx-notes/template",
- "commit": "c781308dbd84e739727ce09aaf798444ced1e7e4",
+ "commit": "0b7d8aa478b37114cef369a217bd1d463e369d37",
  "checkout": null,
  "context": {
  "cookiecutter": {
@@ -14,10 +14,6 @@
  "github_repo": "snippet",
  "pypi_name": "sphinxnotes-snippet",
  "pypi_owner": "SilverRainZ",
- "dependencies": [
- "Sphinx >= 4"
- ],
- "additional_docs": [],
  "_template": "https://github.com/sphinx-notes/template"
  }
  },

MANIFEST.in

@@ -1,4 +1,4 @@
-# This file is generated from sphinx-notes/template.
+# This file is generated from sphinx-notes/cookiecutter.
 # You need to consider modifying the TEMPLATE or modifying THIS FILE.
 
 include LICENSE

Makefile

@@ -1,37 +1,62 @@
-# This file is generated from sphinx-notes/template.
+# This file is generated from sphinx-notes/cookiecutter.
 # You need to consider modifying the TEMPLATE or modifying THIS FILE.
 
 LANG = en_US.UTF-8
 
-MAKE = make
-PY = python3
-RM = rm -rf
+MAKE  = make
+PY  = python3
+RM  = rm -rf
 
+# Build sphinx documentation.
 .PHONY: docs
 docs:
 $(MAKE) -C docs/
 
+# Run unittest.
 .PHONY: test
 test:
 $(PY) -m unittest discover -s tests -v
 
+# Build distribution package, for "install" or "upload".
 .PHONY: dist
 dist: pyproject.toml
 $(RM) dist/ # clean up old dist
 $(PY) -m build
 
+# Install distribution package to user directory.
+#
+# NOTE: It may breaks your system-level packages, use at your own risk.
 .PHONY: install
 install: dist
+export PIP_BREAK_SYSTEM_PACKAGES=1 # required by Python 3.11+, see PEP-668
 $(PY) -m pip install --user --no-deps --force-reinstall dist/*.whl
 
+# Publish wheel to PyPI offical server <https://pypi.org/> when you want to
+# You should have a PyPI account and have PyPI token configured.
+#
+# See also https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives
 .PHONY: upload
 upload: dist
 $(PY) -m twine upload --repository pypi $</*
 
-.PHONY: test-upload
-test-upload: dist
+# 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 $</*
 
+# Keep up to date with the latest template.
+# See also https://github.com/sphinx-notes/cookiecutter.
+.PHONY: update-template
+update-template:
+$(PY) -m cruft update
+
+# 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\" }"
+
 # Usage: make cli args=--help
 .PHONY: cli
 cli:

README.rst

@@ -1,4 +1,4 @@
-.. This file is generated from sphinx-notes/template.
+.. This file is generated from sphinx-notes/cookiecutter.
  You need to consider modifying the TEMPLATE or modifying THIS FILE.
 
 ===================
@@ -17,7 +17,7 @@ sphinxnotes-snippet
  :target: https://pypi.python.org/pypi/sphinxnotes-snippet
  :alt: PyPI Package
 
-.. image:: https://img.shields.io/pypi/dw/sphinxnotes-snippet
+.. image:: https://img.shields.io/pypi/dm/sphinxnotes-snippet
  :target: https://pypi.python.org/pypi/sphinxnotes-snippet
  :alt: PyPI Package Downloads
 

docs/Makefile

@@ -1,4 +1,4 @@
-# This file is generated from sphinx-notes/template.
+# This file is generated from sphinx-notes/cookiecutter.
 # You need to consider modifying the TEMPLATE or modifying THIS FILE.
 
 # Minimal makefile for Sphinx documentation

docs/_images/.gitkeep

@@ -0,0 +1,11 @@
+
+:Type: :py:class:`{{ type }}`
+:Default: ``{{ default }}``
+{% if choice %}:Choices: {% for c in choice %}``{{ c }}`` {% endfor %}{% endif %}
+{% if versionadded %}:Version added: :version:`{{ versionadded }}`{% endif %}
+{% if versionchanged %}:Version changed:{% for i in range(0, versionchanged|count -1, 2) %}
+ :version:`{{ versionchanged[i] }}`
+ {{ versionchanged[i+1] }}{% endfor %}{% endif %}
+
+{{ content }}
+

docs/_images/sphinx-notes.png renamed to docs/_static/sphinx-notes.png

@@ -0,0 +1,31 @@
+
+{% if style is not defined or style == 'tab' %}
+.. tab-set::
+
+ .. tab-item:: Result
+
+ {% for line in content %}{{ line }}
+ {% endfor %}
+
+ .. tab-item:: reStructuredText
+
+ .. code:: rst
+
+ {% for line in content %}{{ line }}
+ {% endfor %}
+{% elif style == 'grid' %}
+.. grid:: 2
+
+ .. grid-item-card:: reStructuredText
+
+ .. code:: rst
+
+ {% for line in content %}{{ line }}
+ {% endfor %}
+
+ .. grid-item-card:: Result
+
+ {% for line in content %}{{ line }}
+ {% endfor %}
+{% endif %}
+

docs/_templates/confval.rst

@@ -1,9 +1,6 @@
-.. list-table::
- :align: left
-
- * - :ref:`📅 {{ date }} <any-version.date>`
- - :tag:`{{ title }}`
 
+:Date: :ref:`📅{{ date }} <any-version.date>`
+:Download: :tag:`{{ title }}`
 
 {% for line in content %}
 {{ line }}