Merge pull request #30 from sphinx-notes/v2

sphinxnotes-snippet v2

Author: SilverRainZ

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/sphinx-notes/template",
-  "commit": "80a61fa9abcd9474d8cfbc36d0bf5d41f99c916c",
+  "commit": "4736b672023e3bf4bc80d0d51850d7bc45ca1e12",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -14,7 +14,13 @@
       "github_repo": "snippet",
       "pypi_name": "sphinxnotes-snippet",
       "pypi_owner": "SilverRainZ",
-      "_template": "https://github.com/sphinx-notes/template"
+      "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/template",
+      "_commit": "4736b672023e3bf4bc80d0d51850d7bc45ca1e12"
     }
   },
   "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 }}

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
 view:
 	$(OPEN) docs/_build/html/index.html
 
 .PHONY: clean
 clean:
-	$(MAKE) -C docs/ clean
-	$(RM) dist/
+	$(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,33 +54,43 @@ 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-done tmpl-apply-rej
+
+tmpl-update:
 	$(PY) -m cruft update
 
-.PHONY: update-template-done
-update-template-done:
+tmpl-update-done:
 	$(GIT) commit -m "chore: Update project template to sphinx-notes/cookiecutter@$(shell jq -r '.commit' .cruft.json | head -c8)"
 
+tmpl-apply-rej:
+	@for rej in $$(find . -name '*.rej'); do \
+		echo "applying $$rej..."; \
+		wiggle --replace $${rej%.rej} $$rej; \
+	done
+
 # Update project version.
-.PHONY: bump-version
+.PHONY: bump-version bump-version-done
+
 bump-version:
 	@echo -n "Please enter the version to bump: "
 	@read version && $(PY) -m cruft update --variables-to-update "{ \"version\" : \"$$version\" }"
 
-# EXTRA TARGETS START
+bump-version-done:
+	VERSION=$(shell jq -r '.context.cookiecutter.version' .cruft.json); \
+	$(GIT) commit -m "chore: Bump version to $$VERSION"; \
+	$(GIT) tag $$VERSION
+
+################################################################################
+# CUSTOM TARGETS
+################################################################################
 
 # Usage: make cli args=--help
 .PHONY: cli
 cli:
 	$(PY) ./utils/cli.py --config ./utils/conf.py $(args)
-
-# EXTRA TARGETS END

README.rst

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

docs/_templates/confval.rst

@@ -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-snippet'
@@ -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.
@@ -74,49 +72,6 @@
 
 # -- 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 = [
-    version_schema,
-    confval_schema,
-    example_schema,
-]
-primary_domain = 'any'
-# 
-
 extensions.append('sphinx.ext.extlinks')
 extlinks = {
     'issue': ('https://github.com/sphinx-notes/snippet/issues/%s', '💬%s'),
@@ -138,29 +93,37 @@
     '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.comboroles')
 comboroles_roles = {
     'parsed_literal': (['literal'], True),
 }
-#
 
-#
+extensions.append('sphinxnotes.project')
+primary_domain = 'any'
+
 # -- Eat your own dog food --------------------------------------------------
 
 # 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('snippet.ext')
+extensions.append('snippet')
 
-# DOG FOOD CONFIGURATION START
+# CUSTOM CONFIGURATION
 
 snippet_config = {
     'cache_dir': '/tmp/' + 'sphinxnotes-snippet'
 }
 
 extensions.append('sphinxcontrib.asciinema')
-
-# DOG FOOD CONFIGURATION END
-#

docs/_templates/example.rst

@@ -5,23 +5,23 @@
 sphinxnotes-snippet
 ===================
 
-.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/snippet/github-pages
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/snippet/github-pages?label=docs
    :target: https://sphinx.silverrainz.me/snippet
    :alt: Documentation Status
-
 .. |license| image:: https://img.shields.io/github/license/sphinx-notes/snippet
    :target: https://github.com/sphinx-notes/snippet/blob/master/LICENSE
    :alt: Open Source License
-
 .. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-snippet.svg
-   :target: https://pypi.python.org/pypi/sphinxnotes-snippet
+   :target: https://pypistats.org/packages/sphinxnotes-snippet
    :alt: PyPI Package
-
 .. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-snippet
    :target: https://pypi.python.org/pypi/sphinxnotes-snippet
    :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/snippet
+   :alt: GitHub Repository
 
-|docs| |license| |pypi| |download|
+|docs| |license| |pypi| |download| |github|
 
 Introduction
 ============
@@ -44,12 +44,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-snippet
 
+
 Then, add the extension name to ``extensions`` configuration item in your
 :parsed_literal:`conf.py_`: