Merge pull request #104 from lsst/tickets/DM-54031

DM-54031: Bump minimum Python version to 3.12 and update docs action to sphinxutils.

Author: MichelleGower

.github/workflows/build.yaml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.11", "3.12", "3.13", "3.14"]
+        python-version: ["3.12", "3.13", "3.14"]
 
     steps:
       - uses: actions/checkout@v6

.github/workflows/build_docs.yaml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: '3.11'
+          python-version: '3.13'
           cache: "pip"
           cache-dependency-path: "setup.cfg"
 
@@ -36,8 +36,8 @@ jobs:
         run: uv pip install --system --no-deps -v .
 
       - name: Install documenteer
-        run: uv pip install --system 'documenteer[pipelines]==0.8.2' sphinx-automodapi==0.19
+        run: uv pip install --system -r doc/requirements.txt
 
       - name: Build documentation
         working-directory: ./doc
-        run: package-docs build -n
+        run: package-docs build -n -W

.gitignore

@@ -21,3 +21,4 @@ pytest_session.txt
 .pytest_cache
 .coverage
 python/*.dist-info/
+doc/api

doc/changes/DM-54031.misc.rst

@@ -0,0 +1 @@
+Removed unused ``isort`` and ``black`` sections from ``pyproject.toml``.  Bumped minimum Python version to 3.12. Switched docs action to use ``sphinxutils``.

doc/conf.py

@@ -2,15 +2,8 @@
 
 This configuration only affects single-package Sphinx documentation builds.
 """
+# ruff: noqa: F403, F405
 
-from documenteer.conf.pipelinespkg import *  # noqa: F403, import *
+from documenteer.conf.guide import *
 
-project = "ctrl_bps_panda"
-html_theme_options["logotext"] = project  # noqa: F405, unknown name
-html_title = project
-html_short_title = project
-doxylink = {}
-exclude_patterns = ["changes/*"]
-
-# Try to pull in links for butler and pipe_base.
-intersphinx_mapping["lsst"] = ("https://pipelines.lsst.io/v/daily/", None)  # noqa
+exclude_patterns.append("changes/*")

doc/documenteer.toml

@@ -0,0 +1,18 @@
+[project]
+title = "lsst-ctrl-bps-panda"
+
+[project.python]
+package = "lsst-ctrl-bps-panda"
+
+[build]
+clean = true
+
+[sphinx]
+extensions = [
+    "sphinx_click"
+]
+
+[sphinx.intersphinx.projects]
+python = "https://docs.python.org/3"
+lsst = "https://pipelines.lsst.io/v/daily/"
+networkx = "https://networkx.org/documentation/stable/"

doc/requirements.txt

@@ -0,0 +1,3 @@
+documenteer[guide] > 2.0, <3.0
+lsst-sphinxutils @ git+https://github.com/lsst/sphinxutils@main
+sphinx-click

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "lsst-ctrl-bps-panda"
-requires-python = ">=3.11.0"
+requires-python = ">=3.12.0"
 description = "PanDA plugin for lsst-ctrl-bps."
 license = "BSD-3-Clause OR GPL-3.0-or-later"
 license-files = ["COPYRIGHT", "LICENSE", "bsd_license.txt", "gpl-v3.0.txt"]
@@ -16,7 +16,6 @@ classifiers = [
     "Intended Audience :: Science/Research",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
@@ -40,6 +39,7 @@ dependencies = [
 dynamic = ["version"]
 [project.urls]
 "Homepage" = "https://github.com/lsst/ctrl_bps_panda"
+"Source" = "https://github.com/lsst/ctrl_bps_panda"
 
 [project.optional-dependencies]
 test = [
@@ -97,15 +97,6 @@ version = { attr = "lsst_versions.get_lsst_version" }
         name = "An API Removal or Deprecation"
         showcontent = true
 
-[tool.black]
-line-length = 110
-target-version = ["py311"]
-
-[tool.isort]
-profile = "black"
-line_length = 110
-known_first_party = ["lsst"]
-
 [tool.lsst_versions]
 write_to = "python/lsst/ctrl/bps/panda/version.py"
 
@@ -124,7 +115,7 @@ add-ignore = ["D107", "D105", "D102", "D100", "D200", "D205", "D400", "D104"]
 
 [tool.ruff]
 line-length = 110
-target-version = "py311"
+target-version = "py312"
 exclude = [
     "__init__.py",
 ]
@@ -188,6 +179,7 @@ checks = [
     "RT01",  # Unfortunately our @property trigger this.
     "RT02",  # Does not want named return value. DM style says we do.
     "SS05",  # pydocstyle is better at finding infinitive verb.
+    "RT03",  # Temporarily disable for sphinx empty returns.
 ]
 exclude = [
     '^__init__$',