Explicitly support Python 3.13, 3.14 and synchronise docs and docs config (#179)

I was about to submit the release when I noticed that `keywords` in
`pyproject.toml` do not include Python 3.13 or 3.14, and that the
package isn't tested with those pythons.

I also noticed I forgot to adjust `.readthedocs.yaml` and developer docs
with release instructions. While I'm here I updated the docs dev setup
to be similar to what we're used to.

Author: snejus

.github/workflows/main.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: ["3.9", "3.10", "3.11", "3.12"]
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
     steps:
       - uses: actions/checkout@v4
       - name: Install Python tools
@@ -23,5 +23,5 @@ jobs:
 
       - name: Test
         run: |-
-          poetry install --extras=test
+          poetry install
           poe test

.readthedocs.yaml

@@ -10,4 +10,5 @@ sphinx:
 
 python:
   install:
-  - requirements: docs/requirements.txt
+    - method: pip
+      path: .

Makefile

@@ -0,0 +1,136 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+SOURCEDIR	  = .
+
+# When both are available, use Sphinx 2.x for autodoc compatibility.
+ifeq ($(shell which sphinx-build2 >/dev/null 2>&1 ; echo $$?),0)
+	SPHINXBUILD = sphinx-build2
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest auto
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/* $(SOURCEDIR)/api/generated/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/beets.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/beets.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/beets"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/beets"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

docs/Makefile

@@ -12,6 +12,8 @@ v2.1.0
 - Added typehints to `as_*` functions which allows for 
   enhanced type checking and IDE support.
 - Added a minimal release workflow for GitHub Actions to automate the release process.
+- Added support for Python 3.13 and Python 3.14.
+- Modernized package and tests setup.
 
 v2.0.1
 ''''''

docs/changelog.rst

@@ -1,19 +1,23 @@
 Development Guide
 =================
 
-This document provides guidelines for developers working on the `confuse` library.
+This document provides guidelines for developers working on the ``confuse``
+library.
 
 Version Bumps
 -------------
 
-This section outlines how to create a new version of the `confuse` library and publish it on PyPi. The versioning follows semantic versioning principles, where the version number is structured as `MAJOR.MINOR.PATCH`.
+This section outlines how to create a new version of the ``confuse`` library
+and publish it on PyPi. The versioning follows semantic versioning principles,
+where the version number is structured as ``MAJOR.MINOR.PATCH``.
 
 To create a new version, follow these steps:
 
-- make sure the changes are documented in the `changelog.rst` file
-- update the version number in `confuse/__init__.py`
-- create a new release in GitHub with the tag `vMAJOR.MINOR.PATCH`
-
-This should trigger the GitHub Actions workflow that builds the package and publishes it to PyPi.
-
-Check if the github actions succeeded by looking at the Actions tab in the repository. If it failed, you can check the logs to see what went wrong and try to fix it.
+1. Navigate to `Make release
+   <https://github.com/beetbox/confuse/actions/workflows/make_release.yaml>`_
+   action in the GitHub repository.
+2. Press **Run workflow**, enter the new version number in the format
+   ``MAJOR.MINOR.PATCH``, e.g., ``1.8.0`` and submit it.
+3. Refresh the page to see the status of the workflow.
+4. Once it succeeds, create a GitHub release with notes from the
+   ``docs/changelog.rst`` file.