From 6dffecd2f91bf0da849f10f9490332709aa935a5 Mon Sep 17 00:00:00 2001 From: Shengyu Zhang Date: Sat, 26 Apr 2025 23:17:04 +0800 Subject: [PATCH] chore: Rename sphinxnotes-snippet to sphinxnotes-fzf --- .cruft.json | 8 +++--- .github/workflows/pypi.yml | 2 +- .github/workflows/release.yml | 2 +- README.rst | 24 ++++++++-------- docs/conf.py | 14 +++++----- docs/index.rst | 28 +++++++++---------- pyproject.toml | 12 ++++---- src/sphinxnotes/{snippet => fzf}/__init__.py | 0 src/sphinxnotes/{snippet => fzf}/cache.py | 0 src/sphinxnotes/{snippet => fzf}/cli.py | 0 .../{snippet => fzf}/config/__init__.py | 0 .../{snippet => fzf}/config/default.py | 0 src/sphinxnotes/{snippet => fzf}/ext.py | 0 .../{snippet => fzf}/integration/__init__.py | 0 .../{snippet => fzf}/integration/binding.nvim | 0 .../{snippet => fzf}/integration/binding.sh | 0 .../{snippet => fzf}/integration/binding.vim | 0 .../{snippet => fzf}/integration/binding.zsh | 0 .../{snippet => fzf}/integration/plugin.sh | 0 .../{snippet => fzf}/integration/plugin.vim | 0 src/sphinxnotes/{snippet => fzf}/keyword.py | 0 src/sphinxnotes/{snippet => fzf}/picker.py | 0 src/sphinxnotes/{snippet => fzf}/snippets.py | 0 src/sphinxnotes/{snippet => fzf}/table.py | 0 .../{snippet => fzf}/utils/__init__.py | 0 .../{snippet => fzf}/utils/ellipsis.py | 0 .../{snippet => fzf}/utils/pdict.py | 0 .../{snippet => fzf}/utils/titlepath.py | 0 28 files changed, 45 insertions(+), 45 deletions(-) rename src/sphinxnotes/{snippet => fzf}/__init__.py (100%) rename src/sphinxnotes/{snippet => fzf}/cache.py (100%) rename src/sphinxnotes/{snippet => fzf}/cli.py (100%) rename src/sphinxnotes/{snippet => fzf}/config/__init__.py (100%) rename src/sphinxnotes/{snippet => fzf}/config/default.py (100%) rename src/sphinxnotes/{snippet => fzf}/ext.py (100%) rename src/sphinxnotes/{snippet => fzf}/integration/__init__.py (100%) rename src/sphinxnotes/{snippet => fzf}/integration/binding.nvim (100%) rename src/sphinxnotes/{snippet => fzf}/integration/binding.sh (100%) rename src/sphinxnotes/{snippet => fzf}/integration/binding.vim (100%) rename src/sphinxnotes/{snippet => fzf}/integration/binding.zsh (100%) rename src/sphinxnotes/{snippet => fzf}/integration/plugin.sh (100%) rename src/sphinxnotes/{snippet => fzf}/integration/plugin.vim (100%) rename src/sphinxnotes/{snippet => fzf}/keyword.py (100%) rename src/sphinxnotes/{snippet => fzf}/picker.py (100%) rename src/sphinxnotes/{snippet => fzf}/snippets.py (100%) rename src/sphinxnotes/{snippet => fzf}/table.py (100%) rename src/sphinxnotes/{snippet => fzf}/utils/__init__.py (100%) rename src/sphinxnotes/{snippet => fzf}/utils/ellipsis.py (100%) rename src/sphinxnotes/{snippet => fzf}/utils/pdict.py (100%) rename src/sphinxnotes/{snippet => fzf}/utils/titlepath.py (100%) diff --git a/.cruft.json b/.cruft.json index 1292e75..c4d66f9 100644 --- a/.cruft.json +++ b/.cruft.json @@ -5,14 +5,14 @@ "context": { "cookiecutter": { "namespace": "sphinxnotes", - "name": "snippet", - "full_name": "sphinxnotes-snippet", + "name": "fzf", + "full_name": "sphinxnotes-fzf", "author": "Shengyu Zhang", "description": "Sphinx documentation snippets manager", "version": "1.2", "github_owner": "sphinx-notes", - "github_repo": "snippet", - "pypi_name": "sphinxnotes-snippet", + "github_repo": "fzf", + "pypi_name": "sphinxnotes-fzf", "pypi_owner": "SilverRainZ", "_template": "https://github.com/sphinx-notes/template", "_commit": "0b096cd7ecff1b28ee8c2887ba3321418be34b9a" diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml index 94eda1a..c59e91c 100644 --- a/.github/workflows/pypi.yml +++ b/.github/workflows/pypi.yml @@ -10,7 +10,7 @@ jobs: runs-on: ubuntu-latest environment: name: pypi - url: https://pypi.org/p/sphinxnotes-snippet + url: https://pypi.org/p/sphinxnotes-fzf permissions: id-token: write # IMPORTANT: this permission is mandatory for trusted publishing steps: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 2c04c00..88e9a26 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -15,4 +15,4 @@ jobs: - uses: ncipollo/release-action@v1 with: body: | - Changelog: https://sphinx.silverrainz.me/snippet/changelog.html + Changelog: https://sphinx.silverrainz.me/fzf/changelog.html diff --git a/README.rst b/README.rst index b0112e3..faad868 100644 --- a/README.rst +++ b/README.rst @@ -1,24 +1,24 @@ .. This file is generated from sphinx-notes/cookiecutter. You need to consider modifying the TEMPLATE or modifying THIS FILE. -=================== -sphinxnotes-snippet -=================== +=============== +sphinxnotes-fzf +=============== -.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/snippet/github-pages - :target: https://sphinx.silverrainz.me/snippet +.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/fzf/github-pages + :target: https://sphinx.silverrainz.me/fzf :alt: Documentation Status -.. |license| image:: https://img.shields.io/github/license/sphinx-notes/snippet - :target: https://github.com/sphinx-notes/snippet/blob/master/LICENSE +.. |license| image:: https://img.shields.io/github/license/sphinx-notes/fzf + :target: https://github.com/sphinx-notes/fzf/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 +.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-fzf.svg + :target: https://pypi.python.org/pypi/sphinxnotes-fzf :alt: PyPI Package -.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-snippet - :target: https://pypi.python.org/pypi/sphinxnotes-snippet +.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-fzf + :target: https://pypi.python.org/pypi/sphinxnotes-fzf :alt: PyPI Package Downloads |docs| |license| |pypi| |download| @@ -32,4 +32,4 @@ Sphinx documentation snippets manager. Please refer to Documentation_ for more details. -.. _Documentation: https://sphinx.silverrainz.me/snippet +.. _Documentation: https://sphinx.silverrainz.me/fzf diff --git a/docs/conf.py b/docs/conf.py index 18d2567..3c53fb8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,7 +12,7 @@ # -- Project information ----------------------------------------------------- -project = 'sphinxnotes-snippet' +project = 'sphinxnotes-fzf' author = 'Shengyu Zhang' copyright = "2023, " + author @@ -61,14 +61,14 @@ # 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/snippet/", + "source_repository": "https://github.com/sphinx-notes/fzf/", "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/snippet' +html_baseurl = 'https://sphinx.silverrainz.me/fzf' html_logo = html_favicon = '_static/sphinx-notes.png' @@ -76,9 +76,9 @@ extensions.append('sphinx.ext.extlinks') extlinks = { - 'issue': ('https://github.com/sphinx-notes/snippet/issues/%s', '💬%s'), - 'pull': ('https://github.com/sphinx-notes/snippet/pull/%s', '🚀%s'), - 'tag': ('https://github.com/sphinx-notes/snippet/releases/tag/%s', '🏷️%s'), + 'issue': ('https://github.com/sphinx-notes/fzf/issues/%s', '💬%s'), + 'pull': ('https://github.com/sphinx-notes/fzf/pull/%s', '🚀%s'), + 'tag': ('https://github.com/sphinx-notes/fzf/releases/tag/%s', '🏷️%s'), } extensions.append('sphinxcontrib.gtagjs') @@ -109,7 +109,7 @@ # 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('snippet') +extensions.append('fzf') # DOG FOOD CONFIGURATION START diff --git a/docs/index.rst b/docs/index.rst index c5067de..108855f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,28 +1,28 @@ .. This file is generated from sphinx-notes/cookiecutter. You need to consider modifying the TEMPLATE or modifying THIS FILE. -=================== -sphinxnotes-snippet -=================== +=============== +sphinxnotes-fzf +=============== -.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/snippet/github-pages?label=docs - :target: https://sphinx.silverrainz.me/snippet +.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/fzf/github-pages?label=docs + :target: https://sphinx.silverrainz.me/fzf :alt: Documentation Status -.. |license| image:: https://img.shields.io/github/license/sphinx-notes/snippet - :target: https://github.com/sphinx-notes/snippet/blob/master/LICENSE +.. |license| image:: https://img.shields.io/github/license/sphinx-notes/fzf + :target: https://github.com/sphinx-notes/fzf/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 +.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes-fzf.svg + :target: https://pypi.python.org/pypi/sphinxnotes-fzf :alt: PyPI Package -.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-snippet - :target: https://pypi.python.org/pypi/sphinxnotes-snippet +.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes-fzf + :target: https://pypi.python.org/pypi/sphinxnotes-fzf :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 + :target: https://github.com/sphinx-notes/fzf :alt: GitHub Repository |docs| |license| |pypi| |download| |github| @@ -52,7 +52,7 @@ First, downloading extension from PyPI: .. code-block:: console - $ pip install sphinxnotes-snippet + $ pip install sphinxnotes-fzf Then, add the extension name to ``extensions`` configuration item in your :parsed_literal:`conf.py_`: @@ -61,7 +61,7 @@ Then, add the extension name to ``extensions`` configuration item in your extensions = [ # … - 'sphinxnotes.snippet', + 'sphinxnotes.fzf', # … ] diff --git a/pyproject.toml b/pyproject.toml index 97c091c..e69c14b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ # https://packaging.python.org/en/latest/specifications/declaring-project-metadata/#declaring-project-metadata [project] -name = "sphinxnotes-snippet" +name = "sphinxnotes-fzf" description = "Sphinx documentation snippets manager" readme = "README.rst" license = { file = "BSD-3-Clause" } @@ -64,11 +64,11 @@ docs = [ ] [project.urls] -homepage = "https://sphinx.silverrainz.me/snippet" -documentation = "https://sphinx.silverrainz.me/snippet" -repository = "https://github.com/sphinx-notes/snippet" -changelog = "https://sphinx.silverrainz.me/snippet/changelog.html" -tracker = "https://github.com/sphinx-notes/snippet/issues" +homepage = "https://sphinx.silverrainz.me/fzf" +documentation = "https://sphinx.silverrainz.me/fzf" +repository = "https://github.com/sphinx-notes/fzf" +changelog = "https://sphinx.silverrainz.me/fzf/changelog.html" +tracker = "https://github.com/sphinx-notes/fzf/issues" [project.scripts] snippet = "sphinxnotes.snippet.cli:main" diff --git a/src/sphinxnotes/snippet/__init__.py b/src/sphinxnotes/fzf/__init__.py similarity index 100% rename from src/sphinxnotes/snippet/__init__.py rename to src/sphinxnotes/fzf/__init__.py diff --git a/src/sphinxnotes/snippet/cache.py b/src/sphinxnotes/fzf/cache.py similarity index 100% rename from src/sphinxnotes/snippet/cache.py rename to src/sphinxnotes/fzf/cache.py diff --git a/src/sphinxnotes/snippet/cli.py b/src/sphinxnotes/fzf/cli.py similarity index 100% rename from src/sphinxnotes/snippet/cli.py rename to src/sphinxnotes/fzf/cli.py diff --git a/src/sphinxnotes/snippet/config/__init__.py b/src/sphinxnotes/fzf/config/__init__.py similarity index 100% rename from src/sphinxnotes/snippet/config/__init__.py rename to src/sphinxnotes/fzf/config/__init__.py diff --git a/src/sphinxnotes/snippet/config/default.py b/src/sphinxnotes/fzf/config/default.py similarity index 100% rename from src/sphinxnotes/snippet/config/default.py rename to src/sphinxnotes/fzf/config/default.py diff --git a/src/sphinxnotes/snippet/ext.py b/src/sphinxnotes/fzf/ext.py similarity index 100% rename from src/sphinxnotes/snippet/ext.py rename to src/sphinxnotes/fzf/ext.py diff --git a/src/sphinxnotes/snippet/integration/__init__.py b/src/sphinxnotes/fzf/integration/__init__.py similarity index 100% rename from src/sphinxnotes/snippet/integration/__init__.py rename to src/sphinxnotes/fzf/integration/__init__.py diff --git a/src/sphinxnotes/snippet/integration/binding.nvim b/src/sphinxnotes/fzf/integration/binding.nvim similarity index 100% rename from src/sphinxnotes/snippet/integration/binding.nvim rename to src/sphinxnotes/fzf/integration/binding.nvim diff --git a/src/sphinxnotes/snippet/integration/binding.sh b/src/sphinxnotes/fzf/integration/binding.sh similarity index 100% rename from src/sphinxnotes/snippet/integration/binding.sh rename to src/sphinxnotes/fzf/integration/binding.sh diff --git a/src/sphinxnotes/snippet/integration/binding.vim b/src/sphinxnotes/fzf/integration/binding.vim similarity index 100% rename from src/sphinxnotes/snippet/integration/binding.vim rename to src/sphinxnotes/fzf/integration/binding.vim diff --git a/src/sphinxnotes/snippet/integration/binding.zsh b/src/sphinxnotes/fzf/integration/binding.zsh similarity index 100% rename from src/sphinxnotes/snippet/integration/binding.zsh rename to src/sphinxnotes/fzf/integration/binding.zsh diff --git a/src/sphinxnotes/snippet/integration/plugin.sh b/src/sphinxnotes/fzf/integration/plugin.sh similarity index 100% rename from src/sphinxnotes/snippet/integration/plugin.sh rename to src/sphinxnotes/fzf/integration/plugin.sh diff --git a/src/sphinxnotes/snippet/integration/plugin.vim b/src/sphinxnotes/fzf/integration/plugin.vim similarity index 100% rename from src/sphinxnotes/snippet/integration/plugin.vim rename to src/sphinxnotes/fzf/integration/plugin.vim diff --git a/src/sphinxnotes/snippet/keyword.py b/src/sphinxnotes/fzf/keyword.py similarity index 100% rename from src/sphinxnotes/snippet/keyword.py rename to src/sphinxnotes/fzf/keyword.py diff --git a/src/sphinxnotes/snippet/picker.py b/src/sphinxnotes/fzf/picker.py similarity index 100% rename from src/sphinxnotes/snippet/picker.py rename to src/sphinxnotes/fzf/picker.py diff --git a/src/sphinxnotes/snippet/snippets.py b/src/sphinxnotes/fzf/snippets.py similarity index 100% rename from src/sphinxnotes/snippet/snippets.py rename to src/sphinxnotes/fzf/snippets.py diff --git a/src/sphinxnotes/snippet/table.py b/src/sphinxnotes/fzf/table.py similarity index 100% rename from src/sphinxnotes/snippet/table.py rename to src/sphinxnotes/fzf/table.py diff --git a/src/sphinxnotes/snippet/utils/__init__.py b/src/sphinxnotes/fzf/utils/__init__.py similarity index 100% rename from src/sphinxnotes/snippet/utils/__init__.py rename to src/sphinxnotes/fzf/utils/__init__.py diff --git a/src/sphinxnotes/snippet/utils/ellipsis.py b/src/sphinxnotes/fzf/utils/ellipsis.py similarity index 100% rename from src/sphinxnotes/snippet/utils/ellipsis.py rename to src/sphinxnotes/fzf/utils/ellipsis.py diff --git a/src/sphinxnotes/snippet/utils/pdict.py b/src/sphinxnotes/fzf/utils/pdict.py similarity index 100% rename from src/sphinxnotes/snippet/utils/pdict.py rename to src/sphinxnotes/fzf/utils/pdict.py diff --git a/src/sphinxnotes/snippet/utils/titlepath.py b/src/sphinxnotes/fzf/utils/titlepath.py similarity index 100% rename from src/sphinxnotes/snippet/utils/titlepath.py rename to src/sphinxnotes/fzf/utils/titlepath.py