bump template to v2024.27 and add support for Django 5.1

.copier/package.yml

@@ -1,12 +1,13 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: v2024.23
+_commit: v2024.27
 _src_path: gh:westerveltco/django-twc-package
 author_email: [email protected]
 author_name: Josh Thomas
 current_version: 0.11.0
 django_versions:
 - '4.2'
 - '5.0'
+- '5.1'
 docs_domain: westervelt.dev
 github_owner: westerveltco
 github_repo: django-simple-nav

.github/CODEOWNERS

@@ -1 +1,2 @@
 *       @westerveltco/oss
+/docs/  @westerveltco/web-dev-docs

.github/workflows/release.yml

@@ -24,7 +24,8 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.12
+          python-version: "3.13"
+          allow-prereleases: true
 
       - name: Install dependencies
         run: |

.github/workflows/test.yml

@@ -24,7 +24,8 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.8"
+          allow-prereleases: true
 
       - name: Install dependencies
         run: |
@@ -47,7 +48,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: "${{ matrix.python-version }}"
           allow-prereleases: true
 
       - name: Install dependencies
@@ -78,7 +79,8 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.13"
+          allow-prereleases: true
 
       - name: Install dependencies
         run: |
@@ -96,7 +98,8 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.8"
+          allow-prereleases: true
 
       - name: Install dependencies
         run: |

README.md

@@ -3,17 +3,17 @@
 <!-- intro-start -->
 [![PyPI](https://img.shields.io/pypi/v/django-simple-nav)](https://pypi.org/project/django-simple-nav/)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-simple-nav)
-![Django Version](https://img.shields.io/badge/django-4.2%20%7C%205.0-%2344B78B?labelColor=%23092E20)
+![Django Version](https://img.shields.io/badge/django-4.2%20%7C%205.0%20%7C%205.1-%2344B78B?labelColor=%23092E20)
 <!-- https://shields.io/badges -->
-<!-- django-4.2 | 5.0-#44B78B -->
+<!-- django-4.2 | 5.0 | 5.1-#44B78B -->
 <!-- labelColor=%23092E20 -->
 
 `django-simple-nav` is a Python/Django application designed to simplify the integration of navigation and menu bars in your Django projects. With a straightforward API and customizable options, you can easily add and manage navigational elements in your web applications. It is designed to be simple to start with, but flexible enough to handle complex navigation structures while maintaining that same simplicity.
 
 ## Requirements
 
 - Python 3.8, 3.9, 3.10, 3.11, 3.12, 3.13
-- Django 4.2, 5.0
+- Django 4.2, 5.0, 5.1
 
 ## Installation
 

docs/_static/css/custom.css

@@ -1,7 +1,9 @@
-// no idea if this will screw a lot up with the furo theme
-// but this does fix the line of badges in the README. only
-// one of them has a link which furo makes the vertical-align
-// different than just a standard img
+/*
+no idea if this will screw a lot up with the furo theme
+but this does fix the line of badges in the README. only
+one of them has a link which furo makes the vertical-align
+different than just a standard img
+*/
 p a.reference img {
-    vertical-align: inherit;
+  vertical-align: inherit;
 }

docs/conf.py

@@ -59,14 +59,14 @@
 # -- MyST configuration ------------------------------------------------------
 myst_heading_anchors = 3
 
-copybutton_selector = "div.copy pre"
-copybutton_prompt_text = "$ "
-
 # -- Options for autodoc2 -----------------------------------------------------
 autodoc2_packages = [f"../src/{project.replace('-', '_')}"]
-
 autodoc2_render_plugin = "myst"
 
+# -- Options for sphinx_copybutton -----------------------------------------------------
+copybutton_selector = "div.copy pre"
+copybutton_prompt_text = "$ "
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

docs/development/contributing.md

@@ -2,4 +2,4 @@
 
 ```
 
-The next section has more information about which `just` commands are available.
+See the [documentation](./just.md) for more information.

docs/development/releasing.md

@@ -1,8 +1,3 @@
-# Releasing
-
-## Releasing a New Version
-
 ```{include} ../../RELEASING.md
-:start-after: <!-- releasing-start -->
-:end-before: <!-- releasing-end -->
+
 ```

docs/index.md

@@ -22,12 +22,20 @@ changelog.md
 apidocs/index.rst
 ```
 
+```{toctree}
+:hidden:
+:maxdepth: 3
+:caption: API Reference
+
+apidocs/django_simple_nav/django_simple_nav.rst
+```
+
 ```{toctree}
 :hidden:
 :maxdepth: 3
 :caption: Development
 
 development/contributing.md
 development/just.md
-development/releasing.md
+Releasing <development/releasing.md>
 ```

noxfile.py

@@ -20,9 +20,10 @@
 
 DJ42 = "4.2"
 DJ50 = "5.0"
+DJ51 = "5.1"
 DJMAIN = "main"
 DJMAIN_MIN_PY = PY310
-DJ_VERSIONS = [DJ42, DJ50, DJMAIN]
+DJ_VERSIONS = [DJ42, DJ50, DJ51, DJMAIN]
 DJ_LTS = [DJ42]
 DJ_DEFAULT = DJ_LTS[0]
 DJ_LATEST = DJ_VERSIONS[-2]

pyproject.toml

@@ -9,6 +9,7 @@ classifiers = [
   "Framework :: Django",
   "Framework :: Django :: 4.2",
   "Framework :: Django :: 5.0",
+  "Framework :: Django :: 5.1",
   "License :: OSI Approved :: MIT License",
   "Operating System :: OS Independent",
   "Programming Language :: Python",

tests/conftest.py

@@ -9,7 +9,7 @@
 
 from .settings import DEFAULT_SETTINGS
 
-pytest_plugins = []  # type: ignore
+pytest_plugins = []
 
 
 def pytest_configure(config):