Chore/py314

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
       max-parallel: 4
       matrix:
         platform: [ubuntu-latest, windows-latest]
-        python-version: [3.9, '3.10', 3.11, 3.12, 3.13]
+        python-version: [3.9, '3.10', 3.11, 3.12, 3.13, 3.14]
         include:
           - python-version: 3.9
             tox-env: py39
@@ -29,6 +29,8 @@ jobs:
             tox-env: py312
           - python-version: '3.13'
             tox-env: py313
+          - python-version: '3.14'
+            tox-env: py314
 
     env:
       TOXENV: ${{ matrix.tox-env }}
@@ -50,9 +52,9 @@ jobs:
         python -m tox
     - name: Upload Results
       if: success()
-      uses: codecov/codecov-action@v4
+      uses: codecov/codecov-action@v5
       with:
-        file: ./coverage.xml
+        files: ./coverage.xml
         flags: unittests
         name: ${{ matrix.platform }}-${{ matrix.tox-env }}
         token: ${{ secrets.CODECOV_TOKEN }} # required

.github/workflows/deploy.yml

@@ -6,45 +6,40 @@ on:
     - '*'
 
 jobs:
-
-  documents:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.13'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip build setuptools wheel
-        python -m pip install -r requirements/docs.txt
-    - name: Deploy documents
-      run: |
-        git config user.name facelessuser
-        git config user.email "${{ secrets.GH_EMAIL }}"
-        git remote add gh-token "https://${{ secrets.GH_TOKEN }}@github.com/facelessuser/Rummage.git"
-        git fetch gh-token && git fetch gh-token gh-pages:gh-pages
-        python -m mkdocs gh-deploy -v --clean --remote-name gh-token
-        git push gh-token gh-pages
-
-  pypi:
+  build:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.13'
-      - name: Package
+          python-version: 3.13
+      - name: Build
         run: |
-          pip install --upgrade build
+          pip install --upgrade pip build
           python -m build -s
-      - name: Publish
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  pypi-publish:
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      # IMPORTANT: this permission is mandatory for Trusted Publishing
+      id-token: write
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          user: __token__
-          password: ${{ secrets.PYPI_PWD }}
+          print-hash: true

.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: publish
+
+on:
+  push:
+    tags:
+    - '*'
+  workflow_dispatch:
+
+jobs:
+
+  documents:
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: ['3.13']
+
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - uses: actions/configure-pages@v5
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: |
+          python -m pip install --upgrade pip build
+          python -m pip install -r requirements/docs.txt
+      - run: python -m zensical.main build -f zensical.yml --clean
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: site
+      - uses: actions/deploy-pages@v4

.gitignore

@@ -1,5 +1,8 @@
 coverage.xml
 
+manifest-css.json
+manifest-js.json
+
 *.py[cod]
 
 # C extensions

LICENSE.md

@@ -1,9 +1,16 @@
 MIT license.
 
-Copyright (c) 2013 - 2025 Isaac Muse <isaacmuse@gmail.com>
+Copyright (c) 2013 - 2026 Isaac Muse <isaacmuse@gmail.com>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs/internal_theme/sitemap.html

@@ -4,10 +4,11 @@
 
   <h2>Documentation Navigation</h2>
 
+  <!-- Navigation list -->
   <ul>
-  {%- for nav_item in nav %}
-    {% include "nav.html" %}
-  {%- endfor %}
+    {% for nav_item in nav.items %}
+      {% include "nav.html" %}
+    {% endfor %}
   </ul>
 
 {%- endblock %}

docs/src/dictionary/en-custom.txt

@@ -83,6 +83,7 @@ Wildcard
 WxFormBuilder
 XFCE
 Xcode
+Zensical
 accessor
 autocomplete
 backend

docs/src/markdown/.snippets/links.md

@@ -14,8 +14,6 @@
 [fullmatch]: https://docs.python.org/3/library/re.html#re.fullmatch
 [grepwin]: http://stefanstools.sourceforge.net/grepWin.html
 [markdown]: https://github.com/Python-Markdown/markdown
-[mkdocs]: https://github.com/mkdocs/mkdocs
-[mkdocs-material]: https://github.com/squidfunk/mkdocs-material
 [posix]: https://facelessuser.github.io/wcmatch/fnmatch/#posix-character-classes
 [pygments]: http://pygments.org/
 [pymdown-extensions]: https://github.com/facelessuser/pymdown-extensions
@@ -27,3 +25,4 @@
 [wcmatch-fnmatch]: https://facelessuser.github.io/wcmatch/fnmatch/#syntax
 [wxpython]: https://pypi.org/project/wxPython/
 [wxpython-prereq]: https://github.com/wxWidgets/Phoenix/blob/master/README.rst#prerequisites
+[zensical]: https://github.com/zensical/zensical

docs/src/markdown/about/changelog.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 4.23
+
+-   **NEW**: Add support for Python 3.14.
+-   **NEW**: Upgrade dependencies.
+
 ## 4.22
 
 -   **NEW**: Drop Python 3.8 support.

docs/src/markdown/about/contributing.md

@@ -88,10 +88,10 @@ with documentation is always appreciated and can be done via pull requests.  The
 validation tests if only updating documentation.
 
 To build the documentation, you will need the necessary requirements. You can get them by running
-`pip install -r requirements/docs.txt`. We currently use a combination of [MkDocs][mkdocs], the
-[Material theme][mkdocs-material], and [PyMdown Extensions][pymdown-extensions] to render the docs.  You can preview
-the docs if you install these packages via the requirements file.  The command for previewing the docs is
-`mkdocs serve`. It should be run from the root directory. You can then view the documents at `localhost:8000`.
+`pip install -r requirements/docs.txt`. We currently use [Zensical][zensical] and [PyMdown Extensions][pymdown-extensions]
+to render the docs.  You can preview the docs if you install these packages via the requirements file.  The command for
+previewing the docs is `zensical serve`. It should be run from the root directory. You can then view the documents at
+`localhost:8000`.
 
 When providing documentation updates, please generate Rummage's internal documentation via `python tools/gen_docs.py`.
 Pull requests will currently fail if the documentation is not updated along with the requested changes.

docs/src/markdown/about/license.md

@@ -2,7 +2,7 @@
 
 MIT license.
 
-Copyright (c) 2013 - 2024 Isaac Muse <isaacmuse@gmail.com>
+Copyright (c) 2013 - 2026 Isaac Muse <isaacmuse@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without limitation the

docs/src/markdown/sitemap.md

@@ -0,0 +1,3 @@
+---
+template: "sitemap.html"
+---

docs/theme/announce.html

@@ -1,5 +1,6 @@
-<a href="{{ 'about/contributing/#contributing--support' | url }}">Sponsorship</a>
+<a href="{{ 'about/contributing/#become-a-sponsor' | url }}">Sponsorship</a>
 is now available!
 <span class="twemoji heart-throb">
-  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16"><path fill-rule="evenodd" d="M7.655 14.916L8 14.25l.345.666a.752.752 0 01-.69 0zm0 0L8 14.25l.345.666.002-.001.006-.003.018-.01a7.643 7.643 0 00.31-.17 22.08 22.08 0 003.433-2.414C13.956 10.731 16 8.35 16 5.5 16 2.836 13.914 1 11.75 1 10.203 1 8.847 1.802 8 3.02 7.153 1.802 5.797 1 4.25 1 2.086 1 0 2.836 0 5.5c0 2.85 2.045 5.231 3.885 6.818a22.075 22.075 0 003.744 2.584l.018.01.006.003h.002z"/></svg>
+  {% set icon = "octicons/heart-fill-16" %}
+  {% include ".icons/" ~ icon ~ ".svg" %}
 </span>