Merge pull request #294 from bskinn/release-2.3.2

Merge 2.3.1.1 release branch back to main

.github/workflows/ci_tests.yml

@@ -4,7 +4,7 @@ on: push
 
 jobs:
   all_checks:
-    name: Run all tests, lints, etc. (Python 3.10)
+    name: Run all tests, lints, etc. (Python 3.11)
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
 
@@ -15,7 +15,7 @@ jobs:
     - name: Install Python
       uses: actions/setup-python@v5
       with:
-        python-version: '3.10'
+        python-version: '3.11'
         cache: 'pip'
         cache-dependency-path: |
           requirements-ci.txt
@@ -63,7 +63,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: ['3.8', '3.9', '3.11', '3.12']
+        python: ['3.8', '3.9', '3.10', '3.12']
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
 
     steps:

CHANGELOG.md

@@ -3,18 +3,12 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project strives to adhere to
-[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+and this project follows an extension of
+[Semantic Versioning](http://semver.org/spec/v2.0.0.html), where a bump in a
+fourth number represents an administrative maintenance release with no code
+changes.
 
-### Unreleased
-
-#### Added
-
-  * The project now supports Python 3.12.
-
-#### Removed
-
-  * Removed support for Python 3.7, which is end-of-life.
+### [2.3.1.1] - 2024-05-21
 
 #### Tests
 
@@ -23,6 +17,10 @@ and this project strives to adhere to
 
 #### Administrative
 
+  * Added formal support for Python 3.12.
+
+  * Removed formal support for Python 3.7, which is end-of-life.
+
   * Bump `checkout` and `setup-python` GitHub Actions versions ([#289]).
 
   * Convert README from reST to Markdown ([#289], fixes [#287]).

CONTRIBUTING.md

@@ -5,8 +5,8 @@ Thanks for your interest in contributing to `sphobjinv`!
 The aim of this document is to provide the information you need
 to get started smoothly on a contribution.
 
-If you have any questions, please drop me a line on Twitter
-([@btskinn](https://twitter.com/btskinn)) or open an
+If you have any questions, please drop me a line on Mastodon
+([@btskinn@fosstodon.org](https://fosstodon.org/@btskinn)) or open an
 [issue](https://github.com/bskinn/sphobjinv/issues).
 
 
@@ -43,7 +43,7 @@ prefer. Any Python interpreter 3.8+ *should* work fine.
 I prefer to use `virtualenv` and create in `./env`:
 
 ```
-$ python3.10 -m virtualenv env --prompt="sphobjinv"
+$ python3.11 -m virtualenv env --prompt="sphobjinv"
 ```
 
 Activate the environment:

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2022 Brian Skinn and community contributors
+Copyright (c) 2016-2024 Brian Skinn and community contributors
 
 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

MANIFEST.in

@@ -1,5 +1,5 @@
 include AUTHORS.md CHANGELOG.md CONTRIBUTING.md LICENSE.txt pyproject.toml
-include README.rst requirements-dev.txt requirements-flake8.txt tox.ini
+include README.md requirements-dev.txt requirements-flake8.txt tox.ini
 
 graft src/sphobjinv/_vendored/fuzzywuzzy
 

README.md

@@ -85,35 +85,34 @@ cross-reference the `linspace` function from numpy (see
 [here][numpy linspace]):
 
 ```none
-$ sphobjinv suggest https://numpy.org/doc/1.23/reference/index.html linspace -su
+$ sphobjinv suggest https://numpy.org/doc/1.26/reference/index.html linspace -su
 
-Attempting https://numpy.org/doc/1.23/reference/index.html ...
+Attempting https://numpy.org/doc/1.26/reference/index.html ...
   ... no recognized inventory.
-Attempting "https://numpy.org/doc/1.23/reference/index.html/objects.inv" ...
+Attempting "https://numpy.org/doc/1.26/reference/index.html/objects.inv" ...
   ... HTTP error: 404 Not Found.
-Attempting "https://numpy.org/doc/1.23/reference/objects.inv" ...
+Attempting "https://numpy.org/doc/1.26/reference/objects.inv" ...
   ... HTTP error: 404 Not Found.
-Attempting "https://numpy.org/doc/1.23/objects.inv" ...
+Attempting "https://numpy.org/doc/1.26/objects.inv" ...
   ... inventory found.
 
-------------------------------------------------
+----------------------------------------------------------------------------------
 
 The intersphinx_mapping for this docset is LIKELY:
 
-  (https://numpy.org/doc/1.23/, None)
+  (https://numpy.org/doc/1.26/, None)
 
-------------------------------------------------
+----------------------------------------------------------------------------------
 
 Project: NumPy
-Version: 1.23
+Version: 1.26
 
-8074 objects in inventory.
+8152 objects in inventory.
 
-------------------------------------------------
+----------------------------------------------------------------------------------
 
 8 results found at/above current threshold of 75.
 
-
   Name                                                           Score
 --------------------------------------------------------------  -------
 :py:function:`numpy.linspace`                                     90
@@ -163,6 +162,7 @@ inventory creation/modification:
 '2.3'
 >>> inv.objects[0]
 DataObjStr(name='sphobjinv.cli.convert', domain='py', role='module', priority='0', uri='cli/implementation/convert.html#module-$', dispname='-')
+
 ```
 
 The API also enables straightforward re-export of an inventory, for subsequent
@@ -178,7 +178,7 @@ Available on [PyPI][pypi link target] (`pip install sphobjinv`).
 Source on [GitHub][github repo]. Bug reports and feature requests are welcomed
 at the [Issues][github issue tracker] page there.
 
-Copyright (c) Brian Skinn 2016-2022
+Copyright (c) Brian Skinn 2016-2024
 
 The `sphobjinv` documentation (including docstrings and README) is licensed
 under a [Creative Commons Attribution 4.0 International License][cc-by 4.0]
@@ -199,7 +199,7 @@ under a [Creative Commons Attribution 4.0 International License][cc-by 4.0]
 [license badge]: https://img.shields.io/github/license/mashape/apistatus.svg
 [license link target]: https://github.com/bskinn/sphobjinv/blob/stable/LICENSE.txt
 [mit license]: https://opensource.org/licenses/MIT
-[numpy linspace]: https://numpy.org/doc/1.23/reference/generated/numpy.linspace.html
+[numpy linspace]: https://numpy.org/doc/1.26/reference/generated/numpy.linspace.html
 [pepy badge]: https://pepy.tech/badge/sphobjinv/month
 [pepy link target]: https://pepy.tech/project/sphobjinv?versions=2.0.1&versions=2.1&versions=2.2.2&versions=2.3&versions=2.3.1
 [pypi badge]: https://img.shields.io/pypi/v/sphobjinv.svg?logo=pypi]

azure-pipelines.yml

@@ -1,6 +1,3 @@
-trigger:
-- release-*
-
 pr:
   branches:
     include:
@@ -26,7 +23,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.10'
+        versionSpec: '3.11'
 
     - task: Cache@2
       inputs:
@@ -58,7 +55,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.10'
+        versionSpec: '3.11'
 
     - task: Cache@2
       inputs:
@@ -127,7 +124,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.10'
+        versionSpec: '3.11'
 
     - task: Cache@2
       inputs:
@@ -153,7 +150,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.10'
+        versionSpec: '3.11'
 
     - task: Cache@2
       inputs:
@@ -171,15 +168,15 @@ stages:
 
 
   - job: readme
-    displayName: Run README doctests/shell tests
+    displayName: Run README doctests
 
     pool:
       vmImage: 'Ubuntu-latest'
 
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.10'
+        versionSpec: '3.11'
 
     - script: pip install -r requirements-ci.txt
       displayName: Install CI requirements
@@ -195,8 +192,8 @@ stages:
     - script: cd doc; make html
       displayName: Build docs
 
-    - script: pytest -k readme --readme --doctest-glob="README.rst"
-      displayName: Run README doc/shell tests
+    - script: pytest -k readme --doctest-glob="README.md"
+      displayName: Run README doctests
 
 
   - job: linkcheck
@@ -208,7 +205,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.10'
+        versionSpec: '3.11'
 
     - task: Cache@2
       inputs:
@@ -234,7 +231,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.10'
+        versionSpec: '3.11'
 
     - task: Cache@2
       inputs:
@@ -250,7 +247,7 @@ stages:
     - script: cd doc; make html; mkdir scratch
       displayName: Build docset
 
-    - script: pytest --cov=. --nonloc --flake8_ext --readme
+    - script: pytest --cov=. --nonloc --flake8_ext
       displayName: Run pytest with coverage on the entire project tree
 
     - script: coverage report --include="tests/*" --fail-under=100
@@ -266,7 +263,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.10'
+        versionSpec: '3.11'
 
     - task: Cache@2
       inputs:

azure-sdisttest.yml

@@ -11,7 +11,7 @@ jobs:
   steps:
   - task: UsePythonVersion@0
     inputs:
-      versionSpec: '3.10'
+      versionSpec: '3.11'
 
   - task: Cache@2
     inputs:

conftest.py

@@ -10,7 +10,7 @@
     20 Mar 2019
 
 **Copyright**
-    \(c) Brian Skinn 2016-2022
+    \(c) Brian Skinn 2016-2024
 
 **Source Repository**
     http://www.github.com/bskinn/sphobjinv
@@ -62,7 +62,6 @@ def pytest_addoption(parser):
     parser.addoption(
         "--flake8_ext", action="store_true", help="Include flake8 extensions test"
     )
-    parser.addoption("--readme", action="store_true", help="Include README shell tests")
 
 
 @pytest.fixture(scope="session")

doc/source/conf.py

@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "sphobjinv"
-copyright = "2016-2022, Brian Skinn"
+copyright = "2016-2024, Brian Skinn"
 author = "Brian Skinn"
 
 # The full version for `release`, including alpha/beta/rc tags

doc/source/customfile.rst

@@ -143,7 +143,7 @@ can be found at the GitHub repo
 
             intersphinx_mapping = {
                 # Standard reference to web docs, with web objects.inv
-                'python': ('https://docs.python.org/3.5', None),
+                'python': ('https://docs.python.org/3.12', None),
 
                 # Django puts its objects.inv file in a non-standard location
                 'django': ('https://docs.djangoproject.com/en/dev/', 'https://docs.djangoproject.com/en/dev/_objects/'),

doc/source/index.rst

@@ -11,7 +11,7 @@ Welcome to sphobjinv!
 
 When documentation is built using, e.g., Sphinx's :obj:`~sphinx.builders.html.StandaloneHTMLBuilder`,
 an inventory of the named objects in the documentation set `is dumped
-<https://github.com/sphinx-doc/sphinx/blob/2f60b44999d7e610d932529784f082fc1c6af989/sphinx/util/inventory.py#L138-L168>`__
+<https://github.com/sphinx-doc/sphinx/blob/adde25689377b58791ad2e357817378ad3a08a1b/sphinx/util/inventory.py#L158-L189>`__
 to a file called |objects.inv| in the html build directory.
 (One common location is, |cour|\ doc/build/html\ |/cour|, though the exact location will vary
 depending on the details of how Sphinx is configured.)  This file is read by |isphx| when
@@ -55,7 +55,7 @@ and package managers, including:
 
   * Alpine Linux: ``py3-sphobjinv`` (`info <https://pkgs.alpinelinux.org/packages?name=py3-sphobjinv>`__)
 
-  * Arch Linux: ``python-sphobjinv`` (`info <https://archlinux.org/packages/extra/any/python-sphobjinv/>`__)
+  * Arch Linux: ``python-sphobjinv``
 
   * Fedora: ``python-sphobjinv`` (`info <https://src.fedoraproject.org/rpms/python-sphobjinv>`__)
 
@@ -73,7 +73,7 @@ and package managers, including:
 
   * pkgsrc: ``textproc/py-sphobjinv`` (`info <https://pkgsrc.se/textproc/py-sphobjinv>`__)
 
-  * spack: ``py-sphobjinv`` (`info <https://packages.spack.io/package.html?name=py-sphobjinv>`__)
+  * spack: ``py-sphobjinv``
 
 
 |soi| is configured for use both as a