sphinxnotes-data 1.0a17__tar.gz

sphinxnotes_data-1.0a17/.cruft.json

@@ -0,0 +1,27 @@
+{
+  "template": "https://github.com/sphinx-notes/cookiecutter",
+  "commit": "251643b4d04376494409369c91f29ca047687a5d",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "namespace": "sphinxnotes",
+      "name": "data",
+      "full_name": "sphinxnotes-data",
+      "author": "Shengyu Zhang",
+      "description": "Use reStructuredText/markdown to define, constrain, render, and analyze data in Sphinx documentations",
+      "version": "1.0a0",
+      "github_owner": "sphinx-notes",
+      "github_repo": "data",
+      "pypi_name": "sphinxnotes-data",
+      "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": "251643b4d04376494409369c91f29ca047687a5d"
+    }
+  },
+  "directory": null
+}

sphinxnotes_data-1.0a17/.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_data-1.0a17/.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-latest
+    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_data-1.0a17/.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-data
+    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_data-1.0a17/.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/data/changelog.html

sphinxnotes_data-1.0a17/.github/workflows/tag.yml

@@ -0,0 +1,28 @@
+name: Tag and Publish every commit
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  tag:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sphinxnotes-project
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'
+      - uses: anothrNick/github-tag-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CUSTOM_TAG: 1.0a${{ github.run_number }}
+      - 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_data-1.0a17/.github/workflows/test.yml

@@ -0,0 +1,16 @@
+name: Test
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 7 * * 6'
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v5
+      with:
+        python-version-file: 'pyproject.toml'
+    - run: python3 -m pip install .[dev]
+    - run: make test

sphinxnotes_data-1.0a17/.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_data-1.0a17/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.11
+    hooks:
+      - id: ruff-check
+        args: [ --fix ]
+      - id: ruff-format

sphinxnotes_data-1.0a17/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_data-1.0a17/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_data-1.0a17/Makefile

@@ -0,0 +1,92 @@
+# 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
+
+.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/ && ruff check --fix src/
+
+.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
+	$(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 $</*
+
+################################################################################
+# 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_data-1.0a17/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: sphinxnotes-data
+Version: 1.0a17
+Summary: Use reStructuredText/markdown to define, constrain, render, and analyze data in Sphinx documentations
+Author: Shengyu Zhang
+Maintainer: Shengyu Zhang
+License-Expression: BSD-3-Clause
+Project-URL: homepage, https://sphinx.silverrainz.me/data
+Project-URL: documentation, https://sphinx.silverrainz.me/data
+Project-URL: repository, https://github.com/sphinx-notes/data
+Project-URL: changelog, https://sphinx.silverrainz.me/data/changelog.html
+Project-URL: tracker, https://github.com/sphinx-notes/data/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
+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"
+Provides-Extra: docs
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinx_design; extra == "docs"
+Requires-Dist: sphinx_copybutton; extra == "docs"
+Requires-Dist: sphinxcontrib-gtagjs; extra == "docs"
+Requires-Dist: sphinx-sitemap; extra == "docs"
+Requires-Dist: sphinxext-opengraph; extra == "docs"
+Requires-Dist: sphinx-last-updated-by-git; extra == "docs"
+Requires-Dist: sphinxnotes-project; extra == "docs"
+Requires-Dist: sphinxnotes-comboroles; extra == "docs"
+Dynamic: license-file
+
+.. This file is generated from sphinx-notes/cookiecutter.
+   You need to consider modifying the TEMPLATE or modifying THIS FILE.
+
+================
+sphinxnotes-data
+================
+
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/data/github-pages
+   :target: https://sphinx.silverrainz.me/data
+   :alt: Documentation Status
+.. |license| image:: https://img.shields.io/github/license/sphinx-notes/data
+   :target: https://github.com/sphinx-notes/data/blob/master/LICENSE
+   :alt: Open Source License
+.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-data.svg
+   :target: https://pypi.python.org/pypi/sphinxnotes-data
+   :alt: PyPI Package
+.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-data
+   :target: https://pypistats.org/packages/sphinxnotes-data
+   :alt: PyPI Package Downloads
+
+|docs| |license| |pypi| |download|
+
+Use reStructuredText/markdown to define, constrain, render, and analyze data in Sphinx documentations.
+
+.. INTRODUCTION START 
+   (MUST written in standard reStructuredText, without Sphinx stuff)
+
+.. INTRODUCTION END
+
+Please refer to Documentation_ for more details.
+
+.. _Documentation: https://sphinx.silverrainz.me/data

sphinxnotes_data-1.0a17/README.rst

@@ -0,0 +1,32 @@
+.. This file is generated from sphinx-notes/cookiecutter.
+   You need to consider modifying the TEMPLATE or modifying THIS FILE.
+
+================
+sphinxnotes-data
+================
+
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/data/github-pages
+   :target: https://sphinx.silverrainz.me/data
+   :alt: Documentation Status
+.. |license| image:: https://img.shields.io/github/license/sphinx-notes/data
+   :target: https://github.com/sphinx-notes/data/blob/master/LICENSE
+   :alt: Open Source License
+.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-data.svg
+   :target: https://pypi.python.org/pypi/sphinxnotes-data
+   :alt: PyPI Package
+.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-data
+   :target: https://pypistats.org/packages/sphinxnotes-data
+   :alt: PyPI Package Downloads
+
+|docs| |license| |pypi| |download|
+
+Use reStructuredText/markdown to define, constrain, render, and analyze data in Sphinx documentations.
+
+.. INTRODUCTION START 
+   (MUST written in standard reStructuredText, without Sphinx stuff)
+
+.. INTRODUCTION END
+
+Please refer to Documentation_ for more details.
+
+.. _Documentation: https://sphinx.silverrainz.me/data

sphinxnotes_data-1.0a17/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_data-1.0a17/docs/changelog.rst

@@ -0,0 +1,20 @@
+.. 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.