Merge pull request #173 from ariebovenberg/py313

Python 3.13 support, docs improvements

.github/workflows/build.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
     - uses: actions/checkout@v1
@@ -25,6 +25,6 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install "tox<5" tox-gh-actions "poetry>=1.7,<1.8"
+        pip install "tox<5" tox-gh-actions "poetry>=1.8,<1.9"
     - name: Test with tox
       run: tox

CHANGELOG.rst

@@ -4,6 +4,12 @@ Changelog
 Next release
 ------------
 
+1.1.1 (2024-10-19)
+------------------
+
+- Explicit Python 3.13 support, drop Python 3.8 support.
+- Docs improvements.
+
 1.1.0 (2023-12-07)
 ------------------
 

docs/conf.py

@@ -1,12 +1,3 @@
-# -*- coding: utf-8 -*-
-#
-# Configuration file for the Sphinx documentation builder.
-#
-# This file does only contain a selection of the most common options. For a
-# full list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
-
-
 # -- Project information -----------------------------------------------------
 import importlib.metadata
 
@@ -20,82 +11,31 @@
 
 # -- General configuration ---------------------------------------------------
 
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
 ]
 
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
 source_suffix = ".rst"
-
-# The master toctree document.
 master_doc = "index"
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path .
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
-# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "tango"
-
 autodoc_member_order = "bysource"
 
-
 # -- Options for HTML output ----------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = "sphinx_material"
-
-# html_static_path = ['_static']
+autodoc_member_order = "bysource"
+html_theme = "furo"
 highlight_language = "python3"
-
-# Material theme options (see theme.conf for more information)
-html_theme_options = {
-    "nav_title": "🦆 Quacks",
-    # Set the color and the accent color
-    "color_primary": "teal",
-    "color_accent": "green",
-    # Set the repo location to get a badge with stats
-    "repo_url": "https://github.com/ariebovenberg/quacks/",
-    "repo_name": "Quacks",
-    # Visible levels of the global TOC; -1 means unlimited
-    "globaltoc_depth": 3,
-    # If False, expand all TOC entries
-    "globaltoc_collapse": False,
-    # If True, show hidden TOC entries
-    "globaltoc_includehidden": False,
-}
-
-
-html_sidebars = {
-    "**": [
-        "logo-text.html",
-        "globaltoc.html",
-        "localtoc.html",
-        "searchbox.html",
-    ]
-}
-
-
-# Example configuration for intersphinx: refer to the Python standard library.
+pygments_style = "default"
+pygments_dark_style = "lightbulb"
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
 }
+toc_object_entries_show_parents = "hide"

docs/requirements.txt

@@ -1,2 +1,2 @@
-sphinx<7.3
-sphinx-material~=0.0.36
+sphinx>8,<9
+furo>=2024.8.6,<2025