sphinxnotes-project 1.0a0__tar.gz

sphinxnotes_project-1.0a0/.cruft.json

@@ -0,0 +1,22 @@
+{
+  "template": "https://github.com/sphinx-notes/cookiecutter",
+  "commit": "e9395e52b94aa56ef6e2e309df6ef3c2ab877b43",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "namespace": "sphinxnotes",
+      "name": "project",
+      "full_name": "sphinxnotes-project",
+      "author": "Shengyu Zhang",
+      "description": "A Sphinx extension that provides useful directives for creating project documentation",
+      "version": "0.1",
+      "github_owner": "sphinx-notes",
+      "github_repo": "project",
+      "pypi_name": "sphinxnotes-project",
+      "pypi_owner": "SilverRainZ",
+      "_template": "https://github.com/sphinx-notes/cookiecutter",
+      "_commit": "e9395e52b94aa56ef6e2e309df6ef3c2ab877b43"
+    }
+  },
+  "directory": null
+}

sphinxnotes_project-1.0a0/.github/workflows/lint.yml

@@ -0,0 +1,9 @@
+name: Ruff
+on: [ push, pull_request ]
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1

sphinxnotes_project-1.0a0/.github/workflows/pages.yml

@@ -0,0 +1,25 @@
+name: Deploy Sphinx documentation to Pages
+
+# Runs on pushes targeting the default branch
+on:
+  push:
+    branches: [master]
+
+# Cancel any in-progress job or run
+# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  pages:
+    runs-on: ubuntu-20.04
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - id: deployment
+      uses: sphinx-notes/pages@v3

sphinxnotes_project-1.0a0/.github/workflows/pypi.yml

@@ -0,0 +1,22 @@
+name: Publish package distributions to PyPI
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sphinxnotes-project
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+    - run: pip install build twine && make dist
+    - uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

sphinxnotes_project-1.0a0/.github/workflows/release.yml

@@ -0,0 +1,18 @@
+name: Publish Github Release
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+" # MAJOR.MINOR (1.0: y, 1.0a0: n, 1.0.1: n)
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ncipollo/release-action@v1
+        with:
+          body: |
+            Changelog: https://sphinx.silverrainz.me/project/changelog.html

sphinxnotes_project-1.0a0/.gitignore

@@ -0,0 +1,137 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Poetry
+poetry.lock
+
+# Sphinx
+docs/_build/
+# sphinxnotes-any >= 2.5
+docs/.any*

sphinxnotes_project-1.0a0/.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.1
+    hooks:
+      - id: ruff
+      - id: ruff-format

sphinxnotes_project-1.0a0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Shengyu Zhang
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

sphinxnotes_project-1.0a0/MANIFEST.in

@@ -0,0 +1,11 @@
+# This file is generated from sphinx-notes/cookiecutter.
+# You need to consider modifying the TEMPLATE or modifying THIS FILE.
+
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

sphinxnotes_project-1.0a0/Makefile

@@ -0,0 +1,81 @@
+# 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
+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 | true
+	$(RM) dist/ | true
+
+.PHONY: clean
+fmt:
+	ruff format src/
+
+# Run unittest.
+.PHONY: test
+test:
+	$(PY) -m unittest discover -s tests -v
+
+# Build distribution package, for "install" or "upload".
+.PHONY: dist
+dist: pyproject.toml clean
+	$(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 $</*
+
+# 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
+
+.PHONY: update-template-done
+update-template-done:
+	$(GIT) commit -m "chore: Update project template to sphinx-notes/cookiecutter@$(shell jq -r '.commit' .cruft.json | head -c8)"
+
+# 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

sphinxnotes_project-1.0a0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.2
+Name: sphinxnotes-project
+Version: 1.0a0
+Summary: A Sphinx extension that provides useful directives for creating project documentation
+Author: Shengyu Zhang
+Maintainer: Shengyu Zhang
+Project-URL: homepage, https://sphinx.silverrainz.me/project
+Project-URL: documentation, https://sphinx.silverrainz.me/project
+Project-URL: repository, https://github.com/sphinx-notes/project
+Project-URL: changelog, https://sphinx.silverrainz.me/project/changelog.html
+Project-URL: tracker, https://github.com/sphinx-notes/project/issues
+Keywords: sphinx,extension,documentation
+Classifier: Environment :: Plugins
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Documentation
+Classifier: Topic :: Documentation :: Sphinx
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: Sphinx>=4
+Requires-Dist: sphinxnotes-any>=3.0a4
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: cruft; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: docs
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinxnotes-project; extra == "docs"
+Requires-Dist: sphinx_design; extra == "docs"
+Requires-Dist: sphinx_copybutton; extra == "docs"
+Requires-Dist: sphinxcontrib-gtagjs; extra == "docs"
+Requires-Dist: sphinxnotes-comboroles; extra == "docs"
+
+.. This file is generated from sphinx-notes/cookiecutter.
+   You need to consider modifying the TEMPLATE or modifying THIS FILE.
+
+===================
+sphinxnotes-project
+===================
+
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/project/github-pages
+   :target: https://sphinx.silverrainz.me/project
+   :alt: Documentation Status
+
+.. |license| image:: https://img.shields.io/github/license/sphinx-notes/project
+   :target: https://github.com/sphinx-notes/project/blob/master/LICENSE
+   :alt: Open Source License
+
+.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-project.svg
+   :target: https://pypi.python.org/pypi/sphinxnotes-project
+   :alt: PyPI Package
+
+.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-project
+   :target: https://pypi.python.org/pypi/sphinxnotes-project
+   :alt: PyPI Package Downloads
+
+|docs| |license| |pypi| |download|
+
+A Sphinx extension that provides useful directives for creating project documentation.
+
+.. INTRODUCTION START 
+   (MUST written in standard reStructuredText, without Sphinx stuff)
+
+.. INTRODUCTION END
+
+Please refer to Documentation_ for more details.
+
+.. _Documentation: https://sphinx.silverrainz.me/project

sphinxnotes_project-1.0a0/README.rst

@@ -0,0 +1,35 @@
+.. This file is generated from sphinx-notes/cookiecutter.
+   You need to consider modifying the TEMPLATE or modifying THIS FILE.
+
+===================
+sphinxnotes-project
+===================
+
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/project/github-pages
+   :target: https://sphinx.silverrainz.me/project
+   :alt: Documentation Status
+
+.. |license| image:: https://img.shields.io/github/license/sphinx-notes/project
+   :target: https://github.com/sphinx-notes/project/blob/master/LICENSE
+   :alt: Open Source License
+
+.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-project.svg
+   :target: https://pypi.python.org/pypi/sphinxnotes-project
+   :alt: PyPI Package
+
+.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-project
+   :target: https://pypi.python.org/pypi/sphinxnotes-project
+   :alt: PyPI Package Downloads
+
+|docs| |license| |pypi| |download|
+
+A Sphinx extension that provides useful directives for creating project documentation.
+
+.. INTRODUCTION START 
+   (MUST written in standard reStructuredText, without Sphinx stuff)
+
+.. INTRODUCTION END
+
+Please refer to Documentation_ for more details.
+
+.. _Documentation: https://sphinx.silverrainz.me/project

sphinxnotes_project-1.0a0/docs/Makefile

@@ -0,0 +1,23 @@
+# This file is generated from sphinx-notes/cookiecutter.
+# You need to consider modifying the TEMPLATE or modifying THIS FILE.
+
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python3 -msphinx
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+default: html
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile default
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

sphinxnotes_project-1.0a0/docs/changelog.rst

@@ -0,0 +1,28 @@
+.. This file is generated from sphinx-notes/cookiecutter.
+   You need to consider modifying the TEMPLATE or modifying THIS FILE.
+
+==========
+Change Log
+==========
+
+.. hint:: You may want to learn about our `Release Strategy`__
+
+   __ https://sphinx.silverrainz.me/release.html
+
+.. Example:
+
+   1.0
+   ===
+
+   .. version:: _
+      :date: yyyy-mm-dd
+
+   Change log here.
+
+Version 1.x
+===========
+
+.. version:: 1.0a0
+   :date: 2025-02-10
+
+   Alpha version~

sphinxnotes_project-1.0a0/docs/conf.py

@@ -0,0 +1,116 @@
+# 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.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import sys
+
+# -- Project information -----------------------------------------------------
+
+project = 'sphinxnotes-project'
+author = 'Shengyu Zhang'
+copyright = "2025, " + author
+
+# The full version, including alpha/beta/rc tags
+version = release = '0.1'
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.githubpages',
+    'sphinx_design',
+    'sphinx_copybutton',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The document name of the “master” document, that is,
+# the document that contains the root toctree directive.
+# Default is 'index', we set it here for supporting Sphinx<2.0
+master_doc = 'index'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# A boolean that decides whether codeauthor and sectionauthor directives
+# produce any output in the built files.
+show_authors = 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/project/",
+    "source_branch": "master",
+    "source_directory": "docs/",
+}
+
+# The URL which points to the root of the HTML documentation.
+# It is used to indicate the location of document like canonical_url
+html_baseurl = 'https://sphinx.silverrainz.me/project'
+
+html_logo = html_favicon = '_static/sphinx-notes.png'
+
+# -- Extensions -------------------------------------------------------------
+
+extensions.append('sphinx.ext.extlinks')
+extlinks = {
+    'issue': ('https://github.com/sphinx-notes/project/issues/%s', '💬%s'),
+    'pull': ('https://github.com/sphinx-notes/project/pull/%s', '🚀%s'),
+    'tag': ('https://github.com/sphinx-notes/project/releases/tag/%s', '🏷️%s'),
+}
+
+extensions.append('sphinxcontrib.gtagjs')
+gtagjs_ids = ['G-E4SNX0WZYV']
+
+extensions.append('sphinx.ext.autodoc')
+autoclass_content = 'init'
+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),
+}
+
+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.
+sys.path.insert(0, os.path.abspath('../src/sphinxnotes'))
+extensions.append('project')
+
+# DOG FOOD CONFIGURATION START
+
+# DOG FOOD CONFIGURATION END

sphinxnotes_project-1.0a0/docs/index.rst

@@ -0,0 +1,99 @@
+.. This file is generated from sphinx-notes/cookiecutter.
+   You need to consider modifying the TEMPLATE or modifying THIS FILE.
+
+===================
+sphinxnotes-project
+===================
+
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/project/github-pages
+   :target: https://sphinx.silverrainz.me/project
+   :alt: Documentation Status
+
+.. |license| image:: https://img.shields.io/github/license/sphinx-notes/project
+   :target: https://github.com/sphinx-notes/project/blob/master/LICENSE
+   :alt: Open Source License
+
+.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-project.svg
+   :target: https://pypi.python.org/pypi/sphinxnotes-project
+   :alt: PyPI Package
+
+.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-project
+   :target: https://pypi.python.org/pypi/sphinxnotes-project
+   :alt: PyPI Package Downloads
+
+|docs| |license| |pypi| |download|
+
+Introduction
+============
+
+.. INTRODUCTION START
+
+A Sphinx extension that provides useful directives for creating project
+documentation
+
+.. warning::
+
+   Currently, this extension is only used internally in `Sphinx Notes`__ and
+   **NO** availability guarantees.
+
+   __ https://sphinx.silverrainz.me/
+
+.. INTRODUCTION END
+
+Getting Started
+===============
+
+.. note::
+
+   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-project
+
+Then, add the extension name to ``extensions`` configuration item in your
+:parsed_literal:`conf.py_`:
+
+.. code-block:: python
+
+   extensions = [
+             # …
+             'sphinxnotes.project',
+             # …
+             ]
+
+.. _Getting Started with Sphinx: https://www.sphinx-doc.org/en/master/usage/quickstart.html
+.. _conf.py: https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+.. ADDITIONAL CONTENT START
+
+Check out :doc:`usage` for all available directives.
+
+.. ADDITIONAL CONTENT END
+
+Contents
+========
+
+.. toctree::
+   :caption: Contents
+
+   usage
+   changelog
+
+The Sphinx Notes Project
+========================
+
+The project is developed by `Shengyu Zhang`__,
+as part of **The Sphinx Notes Project**.
+
+.. toctree::
+   :caption: The Sphinx Notes Project
+
+   Home <https://sphinx.silverrainz.me/>
+   Blog <https://silverrainz.me/blog/category/sphinx.html>
+   PyPI <https://pypi.org/search/?q=sphinxnotes>
+
+__ https://github.com/SilverRainZ

sphinxnotes_project-1.0a0/docs/make.bat

@@ -0,0 +1,37 @@
+REM This file is generated from sphinx-notes/cookiecutter. DO NOT EDIT.
+
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

sphinxnotes_project-1.0a0/docs/usage.rst

@@ -0,0 +1,9 @@
+=====
+Usage
+=====
+
+TODO: document directivces.
+
+.. rst:directive:: version
+.. rst:directive:: confval
+.. rst:directive:: rst-example

sphinxnotes_project-1.0a0/pyproject.toml

@@ -0,0 +1,81 @@
+# 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.
+# Read more about the various options under:
+# https://packaging.python.org/en/latest/specifications/declaring-project-metadata/#declaring-project-metadata
+
+[project]
+name = "sphinxnotes-project"
+description = "A Sphinx extension that provides useful directives for creating project documentation"
+readme = "README.rst"
+license = { file = "BSD-3-Clause" }
+authors = [ { name = "Shengyu Zhang" } ]
+maintainers = [ { name = "Shengyu Zhang" } ]
+keywords = ["sphinx", "extension", "documentation"] # TOOD: additional_keywords
+classifiers = [
+    # "Development Status :: 4 - Beta",
+    "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",
+]
+
+requires-python = ">=3.8"
+dependencies = [
+    "Sphinx >= 4",
+    "sphinxnotes-any >= 3.0a4",
+]
+
+dynamic = ["version"] # required by setuptools_scm, see section [build-system]
+
+[project.optional-dependencies]
+dev = [
+    "build",
+    "twine",
+    "cruft",
+    "ruff",
+    "pre-commit"
+]
+test = [
+    "pytest",
+]
+docs = [
+    "furo",
+    "sphinxnotes-project",
+    "sphinx_design",
+    "sphinx_copybutton",
+    "sphinxcontrib-gtagjs",
+    "sphinxnotes-comboroles",
+]
+
+[project.urls]
+homepage = "https://sphinx.silverrainz.me/project"
+documentation = "https://sphinx.silverrainz.me/project"
+repository = "https://github.com/sphinx-notes/project"
+changelog = "https://sphinx.silverrainz.me/project/changelog.html"
+tracker = "https://github.com/sphinx-notes/project/issues"
+
+[build-system]
+requires = ["setuptools>=46.1.0", "setuptools_scm[toml]>=5", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+# For smarter version schemes and other configuration options,
+# check out https://github.com/pypa/setuptools_scm
+version_scheme = "no-guess-dev"
+
+[tool.setuptools.packages.find]
+# Find namespace package,
+# check out https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#finding-namespace-packages
+where = ["src"]
+
+[tool.setuptools.package-data]
+# A maps from PACKAGE NAMES to lists of glob patterns,
+# see also https://setuptools.pypa.io/en/latest/userguide/datafiles.html
+"sphinxnotes.project.templates" = ["*.*"]

sphinxnotes_project-1.0a0/ruff.toml

@@ -0,0 +1,9 @@
+# This file is generated from sphinx-notes/cookiecutter.
+# You need to consider modifying the TEMPLATE or modifying THIS FILE.
+
+exclude = [
+    "docs/conf.py",
+]
+
+[format]
+quote-style = "single"

sphinxnotes_project-1.0a0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sphinxnotes_project-1.0a0/src/sphinxnotes/project/__init__.py

@@ -0,0 +1,98 @@
+"""
+sphinxnotes.project
+~~~~~~~~~~~~~~~~~~~
+
+Sphinx extension entrypoint.
+
+:copyright: Copyright 2025 Shengyu Zhang
+:license: BSD, see LICENSE for details.
+"""
+
+from __future__ import annotations
+from typing import TYPE_CHECKING
+from importlib.metadata import version
+from os import path
+
+from sphinx.util import logging
+
+from sphinxnotes.any.api import Schema, Field as F, by_year, by_month
+
+if TYPE_CHECKING:
+    from sphinx.application import Sphinx
+    from sphinx.config import Config
+
+
+logger = logging.getLogger(__name__)
+
+
+def _get_template_file(name: str) -> str:
+    """
+    Get file path of template file.
+
+    .. seealso::
+
+       see ``[tool.setuptools.package-data]`` section of pyproject.toml to know
+       how files are included.
+    """
+    prefix = path.abspath(path.dirname(__file__))
+    # TODO: Various parser (md, rst, and ect..) support.
+    return path.join(prefix, 'templates', name + '.rst')
+
+
+def _read_template_file(name: str) -> str:
+    return open(_get_template_file(name), 'r').read()
+
+
+def _config_inited(app: Sphinx, config: Config) -> None:
+    version_schema = Schema(
+        'version',
+        name=F(uniq=True, ref=True, required=True, form=F.Forms.LINES),
+        attrs={
+            'date': F(ref=True, indexers=[by_year, by_month]),
+        },
+        content=F(form=F.Forms.LINES),
+        description_template=_read_template_file('version'),
+        reference_template='🏷️{{ title }}',
+        missing_reference_template='🏷️{{ title }}',
+        ambiguous_reference_template='🏷️{{ title }}',
+    )
+    confval_schema = Schema(
+        'confval',
+        name=F(uniq=True, ref=True, required=True, form=F.Forms.LINES),
+        attrs={
+            'type': F(),
+            'default': F(),
+            'choice': F(form=F.Forms.WORDS),
+            'versionadded': F(),
+            'versionchanged': F(form=F.Forms.LINES),
+        },
+        content=F(),
+        description_template=_read_template_file('confval'),
+        reference_template='⚙️{{ title }}',
+        missing_reference_template='⚙️{{ title }}',
+        ambiguous_reference_template='⚙️{{ title }}',
+    )
+    example_schema = Schema(
+        'rst-example',
+        name=F(ref=True),
+        attrs={'style': F()},
+        content=F(form=F.Forms.LINES),
+        description_template=_read_template_file('example'),
+        reference_template='📝{{ title }}',
+        missing_reference_template='📝{{ title }}',
+        ambiguous_reference_template='📝{{ title }}',
+    )
+
+    config.any_schemas.extend([
+        version_schema,
+        confval_schema,
+        example_schema,
+    ])
+
+
+def setup(app: Sphinx):
+    app.setup_extension('sphinxnotes.any')
+    # Should have priority over sphinxnotes.any's "config-inited" callback.
+    app.connect('config-inited', _config_inited, priority=400)
+
+    return {'version': version('sphinxnotes.project')}

sphinxnotes_project-1.0a0/src/sphinxnotes/project/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 }}
+

sphinxnotes_project-1.0a0/src/sphinxnotes/project/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 %}
+

sphinxnotes_project-1.0a0/src/sphinxnotes/project/templates/version.rst

@@ -0,0 +1,8 @@
+
+:Date: :ref:`📅{{ date }} <any-version.date>`
+:Download: :tag:`{{ title }}`
+
+{% for line in content %}
+{{ line }}
+{% endfor %}
+

sphinxnotes_project-1.0a0/src/sphinxnotes_project.egg-info/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.2
+Name: sphinxnotes-project
+Version: 1.0a0
+Summary: A Sphinx extension that provides useful directives for creating project documentation
+Author: Shengyu Zhang
+Maintainer: Shengyu Zhang
+Project-URL: homepage, https://sphinx.silverrainz.me/project
+Project-URL: documentation, https://sphinx.silverrainz.me/project
+Project-URL: repository, https://github.com/sphinx-notes/project
+Project-URL: changelog, https://sphinx.silverrainz.me/project/changelog.html
+Project-URL: tracker, https://github.com/sphinx-notes/project/issues
+Keywords: sphinx,extension,documentation
+Classifier: Environment :: Plugins
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Documentation
+Classifier: Topic :: Documentation :: Sphinx
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: Sphinx>=4
+Requires-Dist: sphinxnotes-any>=3.0a4
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: cruft; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: docs
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinxnotes-project; extra == "docs"
+Requires-Dist: sphinx_design; extra == "docs"
+Requires-Dist: sphinx_copybutton; extra == "docs"
+Requires-Dist: sphinxcontrib-gtagjs; extra == "docs"
+Requires-Dist: sphinxnotes-comboroles; extra == "docs"
+
+.. This file is generated from sphinx-notes/cookiecutter.
+   You need to consider modifying the TEMPLATE or modifying THIS FILE.
+
+===================
+sphinxnotes-project
+===================
+
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/project/github-pages
+   :target: https://sphinx.silverrainz.me/project
+   :alt: Documentation Status
+
+.. |license| image:: https://img.shields.io/github/license/sphinx-notes/project
+   :target: https://github.com/sphinx-notes/project/blob/master/LICENSE
+   :alt: Open Source License
+
+.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-project.svg
+   :target: https://pypi.python.org/pypi/sphinxnotes-project
+   :alt: PyPI Package
+
+.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-project
+   :target: https://pypi.python.org/pypi/sphinxnotes-project
+   :alt: PyPI Package Downloads
+
+|docs| |license| |pypi| |download|
+
+A Sphinx extension that provides useful directives for creating project documentation.
+
+.. INTRODUCTION START 
+   (MUST written in standard reStructuredText, without Sphinx stuff)
+
+.. INTRODUCTION END
+
+Please refer to Documentation_ for more details.
+
+.. _Documentation: https://sphinx.silverrainz.me/project

sphinxnotes_project-1.0a0/src/sphinxnotes_project.egg-info/SOURCES.txt

@@ -0,0 +1,35 @@
+.cruft.json
+.gitignore
+.pre-commit-config.yaml
+LICENSE
+MANIFEST.in
+Makefile
+README.rst
+pyproject.toml
+ruff.toml
+.github/workflows/lint.yml
+.github/workflows/pages.yml
+.github/workflows/pypi.yml
+.github/workflows/release.yml
+docs/Makefile
+docs/changelog.rst
+docs/conf.py
+docs/index.rst
+docs/make.bat
+docs/usage.rst
+docs/_build/html/_static/file.png
+docs/_build/html/_static/minus.png
+docs/_build/html/_static/plus.png
+docs/_build/html/_static/sphinx-notes.png
+docs/_images/.gitkeep
+docs/_static/.gitkeep
+docs/_static/sphinx-notes.png
+src/sphinxnotes/project/__init__.py
+src/sphinxnotes/project/templates/confval.rst
+src/sphinxnotes/project/templates/example.rst
+src/sphinxnotes/project/templates/version.rst
+src/sphinxnotes_project.egg-info/PKG-INFO
+src/sphinxnotes_project.egg-info/SOURCES.txt
+src/sphinxnotes_project.egg-info/dependency_links.txt
+src/sphinxnotes_project.egg-info/requires.txt
+src/sphinxnotes_project.egg-info/top_level.txt

sphinxnotes_project-1.0a0/src/sphinxnotes_project.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sphinxnotes_project-1.0a0/src/sphinxnotes_project.egg-info/requires.txt

@@ -0,0 +1,20 @@
+Sphinx>=4
+sphinxnotes-any>=3.0a4
+
+[dev]
+build
+twine
+cruft
+ruff
+pre-commit
+
+[docs]
+furo
+sphinxnotes-project
+sphinx_design
+sphinx_copybutton
+sphinxcontrib-gtagjs
+sphinxnotes-comboroles
+
+[test]
+pytest

sphinxnotes_project-1.0a0/src/sphinxnotes_project.egg-info/top_level.txt

@@ -0,0 +1 @@
+sphinxnotes