chore: Sync with cookiecutter template

sphinx-notes · Dec 26, 2023 · bf27f2d · bf27f2d
1 parent 4d322f1
commit bf27f2d
Show file tree

Hide file tree

Showing 15 changed files with 102 additions and 36 deletions.
diff --git a/.cruft.json b/.cruft.json
@@ -1,6 +1,6 @@
 {
-  "template": "https://github.com/sphinx-notes/template",
-  "commit": "93c85ed7fe6dc87e11ffd024b762a3c8c9a83a1b",
+  "template": "https://github.com/sphinx-notes/cookiecutter",
+  "commit": "0b7d8aa478b37114cef369a217bd1d463e369d37",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -9,12 +9,12 @@
       "full_name": "sphinxnotes-comboroles",
       "author": "Shengyu Zhang",
       "description": "Sphinx extension for composing multiple roles",
-      "version": "0.1.0",
+      "version": "1.0.0a0",
       "github_owner": "sphinx-notes",
       "github_repo": "comboroles",
       "pypi_name": "sphinxnotes-comboroles",
       "pypi_owner": "SilverRainZ",
-      "_template": "https://github.com/sphinx-notes/template"
+      "_template": "https://github.com/sphinx-notes/cookiecutter"
     }
   },
   "directory": null

diff --git a/MANIFEST.in b/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

diff --git a/Makefile b/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.
 
 LANG = en_US.UTF-8
@@ -46,7 +46,7 @@ upload-test: dist
 	$(PY) -m twine upload --repository testpypi $</*
 
 # Keep up to date with the latest template.
-# See also https://github.com/sphinx-notes/template.
+# See also https://github.com/sphinx-notes/cookiecutter.
 .PHONY: update-template
 update-template:
 	$(PY) -m cruft update

diff --git a/README.rst b/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-comboroles
    :target: https://pypi.python.org/pypi/sphinxnotes-comboroles
    :alt: PyPI Package
 
-.. image:: https://img.shields.io/pypi/dw/sphinxnotes-comboroles
+.. image:: https://img.shields.io/pypi/dm/sphinxnotes-comboroles
    :target: https://pypi.python.org/pypi/sphinxnotes-comboroles
    :alt: PyPI Package Downloads
 

diff --git a/docs/Makefile b/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

diff --git a/docs/_images/.gitkeep b/docs/_images/.gitkeep
diff --git a/docs/_images/sphinx-notes.png → docs/_static/sphinx-notes.png b/docs/_images/sphinx-notes.png → docs/_static/sphinx-notes.png
diff --git a/docs/_templates/confval.rst b/docs/_templates/confval.rst
@@ -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 }}
+
diff --git a/docs/_templates/example.rst b/docs/_templates/example.rst
@@ -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 %}
+
diff --git a/docs/_templates/version.rst b/docs/_templates/version.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 }}

diff --git a/docs/changelog.rst b/docs/changelog.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.
 
 ==========

diff --git a/docs/conf.py b/docs/conf.py
@@ -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.
 
 # Configuration file for the Sphinx documentation builder.
@@ -17,7 +17,7 @@
 copyright = "2023, " + author
 
 # The full version, including alpha/beta/rc tags
-version = release = '0.1.0'
+version = release = '1.0.0a0'
 
 # -- General configuration ---------------------------------------------------
 
@@ -70,38 +70,64 @@
 # It is used to indicate the location of document like canonical_url
 html_baseurl = 'https://sphinx.silverrainz.me/comboroles'
 
-html_logo = html_favicon = '_images/sphinx-notes.png'
+html_logo = html_favicon = '_static/sphinx-notes.png'
 
 # -- Extensions -------------------------------------------------------------
 
 #  
 extensions.append('sphinxnotes.any')
 from sphinxnotes.any import Schema, Field as F
+#
+version_schema = Schema('version',
+                        name=F(unique=True, referenceable=True, required=True, form=F.Form.LINES),
+                        attrs={'date': F(referenceable=True)},
+                        content=F(form=F.Form.LINES),
+                        description_template=open('_templates/version.rst', 'r').read(),
+                        reference_template='🏷️{{ title }}',
+                        missing_reference_template='🏷️{{ title }}',
+                        ambiguous_reference_template='🏷️{{ title }}')
+confval_schema = Schema('confval',
+                        name=F(unique=True, referenceable=True, required=True, form=F.Form.LINES),
+                        attrs={
+                            'type': F(),
+                            'default': F(),
+                            'choice': F(form=F.Form.WORDS),
+                            'versionadded': F(),
+                            'versionchanged': F(form=F.Form.LINES),
+                        },
+                        content=F(),
+                        description_template=open('_templates/confval.rst', 'r').read(),
+                        reference_template='⚙️{{ title }}',
+                        missing_reference_template='⚙️{{ title }}',
+                        ambiguous_reference_template='⚙️{{ title }}')
+example_schema = Schema('example',
+                        name=F(referenceable=True),
+                        attrs={'style': F()},
+                        content=F(form=F.Form.LINES),
+                        description_template=open('_templates/example.rst', 'r').read(),
+                        reference_template='📝{{ title }}',
+                        missing_reference_template='📝{{ title }}',
+                        ambiguous_reference_template='📝{{ title }}')
+#
 any_schemas = [
-    #
-    Schema('version',
-           name=F(unique=True, referenceable=True, required=True, form=F.Form.LINES),
-           attrs={'date': F(referenceable=True)},
-           content=F(form=F.Form.LINES),
-           description_template=open('_templates/version.rst', 'r').read(),
-           reference_template='💽 {{ title }}',
-           missing_reference_template='💽 {{ title }}',
-           ambiguous_reference_template='💽 {{ title }}'),
-    #
+    version_schema,
+    confval_schema,
+    example_schema,
 ]
 primary_domain = 'any'
 # 
 
 extensions.append('sphinx.ext.extlinks')
 extlinks = {
-    'issue': ('https://github.com/sphinx-notes/comboroles/issues/%s', '💬 %s'),
-    'pull': ('https://github.com/sphinx-notes/comboroles/pull/%s', '🚀 %s'),
-    'tag': ('https://github.com/sphinx-notes/comboroles/releases/tag/%s', '🏷️ %s'),
+    'issue': ('https://github.com/sphinx-notes/comboroles/issues/%s', '💬%s'),
+    'pull': ('https://github.com/sphinx-notes/comboroles/pull/%s', '🚀%s'),
+    'tag': ('https://github.com/sphinx-notes/comboroles/releases/tag/%s', '🏷️%s'),
 }
 
 extensions.append('sphinxcontrib.gtagjs')
 gtagjs_ids = ['G-E4SNX0WZYV']
 
+#  
 # -- Eat your own dog food --------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -118,3 +144,4 @@
 }
 
 # DOG FOOD CONFIGURATION END
+# 
diff --git a/docs/index.rst b/docs/index.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.
 
 .. include:: ../README.rst
@@ -98,7 +98,7 @@ Contents
 The Sphinx Notes Project
 ========================
 
-This project is a developed by `Shengyu Zhang`__,
+The project is developed by `Shengyu Zhang`__,
 as part of **The Sphinx Notes Project**.
 
 .. toctree::

diff --git a/docs/make.bat b/docs/make.bat
@@ -1,4 +1,4 @@
-REM This file is generated from sphinx-notes/template. DO NOT EDIT.
+REM This file is generated from sphinx-notes/cookiecutter. DO NOT EDIT.
 
 @ECHO OFF
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -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.
 
 # This file is used to configure your project.