sphinxnotes-recentupdate 1.0b2__tar.gz → 2.0a0__tar.gz

sphinxnotes_recentupdate-2.0a0/.cruft.json

@@ -0,0 +1,29 @@
+{
+  "template": "https://github.com/sphinx-notes/cookiecutter",
+  "commit": "233a8daa4e276a9559975a51178f29e7079dcafd",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "namespace": "sphinxnotes",
+      "name": "recentupdate",
+      "full_name": "sphinxnotes-recentupdate",
+      "author": "Shengyu Zhang",
+      "description": "Get the document update information from git and display it in Sphinx documentation",
+      "version": "1.1",
+      "github_owner": "sphinx-notes",
+      "github_repo": "recentupdate",
+      "generated_file_header": "This file is generated from sphinx-notes/cookiecutter.",
+      "dont_edit_header": "DO NOT EDIT.",
+      "pypi_name": "sphinxnotes-recentupdate",
+      "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": "233a8daa4e276a9559975a51178f29e7079dcafd"
+    }
+  },
+  "directory": null
+}

sphinxnotes_recentupdate-2.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_recentupdate-2.0a0/.github/workflows/pages.yml

@@ -0,0 +1,30 @@
+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-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - id: deployment
+      uses: sphinx-notes/pages@v3
+      with:
+        checkout: false

sphinxnotes_recentupdate-2.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-recentupdate
+    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_recentupdate-2.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/recentupdate/changelog.html

sphinxnotes_recentupdate-2.0a0/.gitignore

@@ -0,0 +1,141 @@
+# This file is generated from sphinx-notes/cookiecutter.
+
+# 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*
+
+.worktrees/

sphinxnotes_recentupdate-2.0a0/.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+# This file is generated from sphinx-notes/cookiecutter.
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.11
+    hooks:
+      - id: ruff-check
+        args: [ --fix ]
+      - id: ruff-format

sphinxnotes_recentupdate-2.0a0/AGENTS.md

@@ -0,0 +1,40 @@
+<!-- This file is generated from sphinx-notes/cookiecutter. --> 
+
+## 基本说明
+
+这是一个由 SphinxNotes 开发的 Sphinx Extension，由 `sphinxnotes/cookiecutter` 生成，很多基础文件来自模板。
+
+## 首先阅读
+
+- 开始了解项目时，优先阅读 `docs/index.rst`。
+- 如果任务和文档、Sphinx 配置或示例有关，继续阅读 `docs/` 下的其他文件
+
+## 通用知识
+
+- 使用 `make` 会构建 `docs/` 下的文档，文档自依赖当前项目，因此文档构建成功也意味着项目基本能正常构建
+  - `docs/_build` 存放构建好的文档，`make clean` 清除所有构建结果
+  - `make test` 运行测试，测试位于 `tests/`，可能的 e2e 测试位于 `tests/test_e2e.py`
+  - `make doctest` 运行 Sphinx 文档测试
+  - `make install` 使用 `pip install --user` 将项目安装到本地，跨项目测试时常用
+- `make tmpl-*` 用于模板同步，参看 "模板同步" 小节
+
+## 关于 SphinxNotes 项目
+
+- 同为 `sphinxnotes` 项目的其他仓库通常位于当前项目的上一级目录
+- 如果你在阅读代码时遇到本地依赖、模板来源或跨仓库复用关系，可以直接读取这些本地仓库文件，不必先猜测实现，也不必优先去远程搜索。
+- 当我提到 "所有项目" 的时候，请从当前项目的上一级目录的 `cookiecutter/project-list.txt` 获取项目列表
+- `docs/conf.py` 往往会直接从源码树导入当前项目，因此排查文档构建问题时，要同时检查运行时依赖和文档依赖。
+
+## 模板同步
+
+- 先确认任务是当前项目问题，还是模板问题；如果是模板问题，优先在 `sphinxnotes/cookiecutter` 中修复。
+- 模板变更完成后，优先使用 `make tmpl-update` 把改动同步回项目，而不是手工重复修改生成文件。
+- 如果 `make tmpl-update` 产生 `.rej`、冲突或三方合并失败，优先尝试 `make tmpl-apply-rej`，再手工解决冲突。
+- 手工解决冲突时，重点检查 `README.rst`、`pyproject.toml`、`.github/workflows/`、`docs/conf.py`、`docs/requirements.txt` 这些常见受影响文件。
+- 当模板同步结果确认无误后，优先使用 `make tmpl-update-done` 完成后续收尾步骤。
+
+### 修改约定
+
+- 修改模板生成文件时，保留原有注释，除非模板本身已经统一移除了这些注释。
+- 遇到 `CUSTOM ... START` / `END` 这类用户自定义区块时，必须保留这些锚点，并尽量保留区块中的用户内容。
+- 如果模板更新和项目内手工修改发生冲突，优先保护用户自定义内容，再整理模板变更。

{sphinxnotes-recentupdate-1.0b2 → sphinxnotes_recentupdate-2.0a0}/LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2021, Sphinx Notes
+Copyright (c) 2025, Shengyu Zhang
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -26,4 +26,4 @@ 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.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

sphinxnotes_recentupdate-2.0a0/MANIFEST.in

@@ -0,0 +1,10 @@
+# This file is generated from sphinx-notes/cookiecutter.
+
+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_recentupdate-2.0a0/Makefile

@@ -0,0 +1,96 @@
+# This file is generated from sphinx-notes/cookiecutter.
+
+LANG = en_US.UTF-8
+
+MAKE  = make
+PY    = python3
+RM    = rm -rf
+GIT   = git
+OPEN  = xdg-open
+
+.PHONY: docs
+docs:
+	$(MAKE) -C docs/
+
+.PHONY: view
+view:
+	$(OPEN) docs/_build/html/index.html
+
+.PHONY: clean
+clean:
+	$(MAKE) -C docs/ clean; $(RM) dist/
+
+.PHONY: fmt
+fmt:
+	ruff format src/ tests/ && ruff check --fix src/ tests/
+
+.PHONY: test
+test:
+	$(PY) -m pytest tests/ -v
+
+.PHONY: doctest
+doctest:
+	$(MAKE) doctest -C docs/
+
+################################################################################
+# Distribution Package
+################################################################################
+
+# Build distribution package, for "install" or "upload".
+.PHONY: dist
+dist: pyproject.toml clean
+	# Use ``--no-isolation`` to prevent network accessing when in local env.
+	$(PY) -m build $(if $(CI),,--no-isolation)
+
+# 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 $</*
+
+################################################################################
+# Cookiecutter Incremental Updates
+################################################################################
+
+# Keep up to date with the latest template.
+# See https://github.com/sphinx-notes/cookiecutter.
+.PHONY: tmpl-update tmpl-update-done tmpl-apply-rej
+
+tmpl-update:
+	$(PY) -m cruft update
+
+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 bump-version-done
+
+bump-version:
+	@echo -n "Please enter the version to bump: "
+	@read version && $(PY) -m cruft update --variables-to-update "{ \"version\" : \"$$version\" }"
+
+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
+################################################################################

sphinxnotes_recentupdate-2.0a0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: sphinxnotes-recentupdate
+Version: 2.0a0
+Summary: Get the document update information from git and display it in Sphinx documentation
+Author: Shengyu Zhang
+Maintainer: Shengyu Zhang
+License-Expression: BSD-3-Clause
+Project-URL: homepage, https://sphinx.silverrainz.me/recentupdate
+Project-URL: documentation, https://sphinx.silverrainz.me/recentupdate
+Project-URL: repository, https://github.com/sphinx-notes/recentupdate
+Project-URL: changelog, https://sphinx.silverrainz.me/recentupdate/changelog.html
+Project-URL: tracker, https://github.com/sphinx-notes/recentupdate/issues
+Keywords: sphinx,extension,documentation,sphinxnotes
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Plugins
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Documentation
+Classifier: Topic :: Documentation :: Sphinx
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: Sphinx>=7.0
+Requires-Dist: GitPython
+Requires-Dist: sphinxnotes-render
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: cruft; extra == "dev"
+Requires-Dist: ruff>=0.11.10; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+.. This file is generated from sphinx-notes/cookiecutter.
+
+========================
+sphinxnotes-recentupdate
+========================
+
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/recentupdate/github-pages
+   :target: https://sphinx.silverrainz.me/recentupdate
+   :alt: Documentation Status
+.. |license| image:: https://img.shields.io/github/license/sphinx-notes/recentupdate
+   :target: https://github.com/sphinx-notes/recentupdate/blob/master/LICENSE
+   :alt: Open Source License
+.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-recentupdate.svg
+   :target: https://pypi.python.org/pypi/sphinxnotes-recentupdate
+   :alt: PyPI Package
+.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-recentupdate
+   :target: https://pypistats.org/packages/sphinxnotes-recentupdate
+   :alt: PyPI Package Downloads
+
+|docs| |license| |pypi| |download|
+
+Get the document update information from git and display it in Sphinx 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/recentupdate

sphinxnotes_recentupdate-2.0a0/README.rst

@@ -0,0 +1,31 @@
+.. This file is generated from sphinx-notes/cookiecutter.
+
+========================
+sphinxnotes-recentupdate
+========================
+
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/recentupdate/github-pages
+   :target: https://sphinx.silverrainz.me/recentupdate
+   :alt: Documentation Status
+.. |license| image:: https://img.shields.io/github/license/sphinx-notes/recentupdate
+   :target: https://github.com/sphinx-notes/recentupdate/blob/master/LICENSE
+   :alt: Open Source License
+.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-recentupdate.svg
+   :target: https://pypi.python.org/pypi/sphinxnotes-recentupdate
+   :alt: PyPI Package
+.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-recentupdate
+   :target: https://pypistats.org/packages/sphinxnotes-recentupdate
+   :alt: PyPI Package Downloads
+
+|docs| |license| |pypi| |download|
+
+Get the document update information from git and display it in Sphinx 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/recentupdate

{sphinxnotes-recentupdate-1.0b2/doc → sphinxnotes_recentupdate-2.0a0/docs}/Makefile

@@ -1,10 +1,10 @@
+# This file is generated from sphinx-notes/cookiecutter.
+
 # Minimal makefile for Sphinx documentation
-#
 
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python3 -msphinx
 SOURCEDIR     = .
 BUILDDIR      = _build
 

sphinxnotes_recentupdate-2.0a0/docs/_images/.gitkeep

@@ -0,0 +1 @@
+# This file is generated from sphinx-notes/cookiecutter.

sphinxnotes_recentupdate-2.0a0/docs/_static/.gitkeep

@@ -0,0 +1 @@
+# This file is generated from sphinx-notes/cookiecutter.

sphinxnotes_recentupdate-2.0a0/docs/_static/custom.css

@@ -0,0 +1,10 @@
+/* This file is generated from sphinx-notes/cookiecutter.
+ * DO NOT EDIT.
+ */
+
+/* Missing style for nodes.system_message from Alabaster. */
+.system-message {
+    background-color: #fda;
+    padding: 5px;
+    border: 3px solid red;
+}

sphinxnotes_recentupdate-2.0a0/docs/changelog.rst

@@ -0,0 +1,57 @@
+.. This file is generated from sphinx-notes/cookiecutter.
+
+==========
+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 2.x
+===========
+
+.. version:: 2.0
+   :break:
+
+   - The template feature is now provided by
+     :external+render:doc:`sphinxnotes-render <index>`. It offers richer features;
+     Please see :external+render:doc:`tmpl`
+   - The extension now provides a ``recentupdate`` extra context for replacing 
+     the ``.. recentupdate::`` directive. See :doc:`usage` for more details
+
+   BREAKING CHANGES:
+
+   - Drop the ``.. recentupdate::`` directive
+   - Drop the ``strftime`` and ``roles`` filters
+   - Drop the ``recentupdate_date_format``, ``recentupdate_template``, and
+     ``recentupdate_exclude_path`` confvals
+   - The members of :py:class:`~sphinxnotes.recentupdate.Revision` are renamed
+
+Version 1.x
+===========
+
+.. version:: 1.1
+   :date: 2025-10-30
+
+   - fix: Deal with case when sphinx srcdir != git workdir
+
+.. version:: 1.0
+   :date: 2025-10-17
+
+   First stable version after five years :-)
+
+.. version:: 1.0a0
+   :date: 2021-12-06 
+
+   Release alpha version.