chore: Rename sphinxnotes-snippet to sphinxnotes-fzf

Author: SilverRainZ

.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"

.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:

.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

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

docs/conf.py

@@ -12,7 +12,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'sphinxnotes-snippet'
+project = 'sphinxnotes-fzf'
 author = 'Shengyu Zhang'
 copyright = "2023, " + author
 
@@ -61,24 +61,24 @@
 # 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'
 
 # -- Extensions -------------------------------------------------------------
 
 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
 

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',
              # …
              ]
 

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"