Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

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/)
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project follows an extension of
[Semantic Versioning](http://semver.org/spec/v2.0.0.html), where a bump in a
[Semantic Versioning](https://semver.org/spec/v2.0.0.html), where a bump in a
fourth number represents an administrative maintenance release with no code
changes.

Expand All @@ -21,6 +21,12 @@ changes.

#### Tests

* Add 3.13t and 3.14t to `tox` test matrix ([#333]).
* Also add report of the current GIL status to the `tox` env output.

* Filter newly emerged `ResourceWarning` emitted from implicit cleanup of
`tempfile` resources ([#333]).

* Add tests exercising the new `sphobjinv-textconv` CLI entrypoint ([#331]).
* Required generalizing the `run_cmdline_test` fixture so that tests can
choose between the core and textconv entrypoints.
Expand Down Expand Up @@ -99,6 +105,8 @@ changes.

#### Administrative

* Convert several `http://` to `https://` across the project ([#333]).

* Add formal support for Python 3.14 ([#325]).

* Drop support for Python 3.9 (EOL) ([#325]).
Expand Down Expand Up @@ -780,3 +788,4 @@ changes.
[#325]: https://github.com/bskinn/sphobjinv/pull/325
[#327]: https://github.com/bskinn/sphobjinv/pull/327
[#331]: https://github.com/bskinn/sphobjinv/pull/331
[#333]: https://github.com/bskinn/sphobjinv/pull/333
2 changes: 1 addition & 1 deletion CONTENT_LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The sphobjinv documentation (including docstrings and README) is licensed under
a Creative Commons Attribution 4.0 International License (CC-BY).

See http://creativecommons.org/licenses/by/4.0/.
See https://creativecommons.org/licenses/by/4.0/.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,8 @@ under a [Creative Commons Attribution 4.0 International License][cc-by 4.0]

[black badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black link target]: https://github.com/psf/black
[cc-by 4.0]: http://creativecommons.org/licenses/by/4.0/
[soi docs inv export]: http://sphobjinv.readthedocs.io/en/latest/api_usage.html#exporting-an-inventory
[cc-by 4.0]: https:/creativecommons.org/licenses/by/4.0/
[soi docs inv export]: https://sphobjinv.readthedocs.io/en/latest/api_usage.html#exporting-an-inventory
[github issue tracker]: https://github.com/bskinn/sphobjinv/issues
[github repo]: https://github.com/bskinn/sphobjinv
[gitter badge]: https://badges.gitter.im/sphobjinv/community.svg
Expand All @@ -203,6 +203,6 @@ under a [Creative Commons Attribution 4.0 International License][cc-by 4.0]
[pypi link target]: https://pypi.org/project/sphobjinv
[python versions badge]: https://img.shields.io/pypi/pyversions/sphobjinv.svg?logo=python
[readthedocs badge]: https://img.shields.io/readthedocs/sphobjinv/latest.svg
[readthedocs link target]: http://sphobjinv.readthedocs.io/en/latest/
[readthedocs link target]: https://sphobjinv.readthedocs.io/en/latest/
[workflow badge]: https://img.shields.io/github/actions/workflow/status/bskinn/sphobjinv/all_core_tests.yml?logo=github&branch=main
[workflow link target]: https://github.com/bskinn/sphobjinv/actions
2 changes: 1 addition & 1 deletion doc/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ if errorlevel 9009 (
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
echo.https://sphinx-doc.org/
exit /b 1
)

Expand Down
4 changes: 2 additions & 2 deletions doc/source/_templates/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
</p>

<p class="footer-license">
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a>
<a rel="license" href="https://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a>
&nbsp;&nbsp;
<span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">The sphobjinv documentation</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
<span xmlns:dct="https://purl.org/dc/terms/" property="dct:title">The sphobjinv documentation</span> is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
</p>

{% endblock %}
2 changes: 1 addition & 1 deletion tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down
2 changes: 1 addition & 1 deletion tests/enum.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures_http.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down
2 changes: 1 addition & 1 deletion tests/test_api_fail.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down
2 changes: 1 addition & 1 deletion tests/test_api_good.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down
2 changes: 1 addition & 1 deletion tests/test_api_good_nonlocal.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down
2 changes: 1 addition & 1 deletion tests/test_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down
18 changes: 10 additions & 8 deletions tests/test_cli_nonlocal.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down Expand Up @@ -133,6 +133,7 @@ def test_cli_url_in_json(
assert "objects" in d.get("metadata", {}).get("url", {})

@pytest.mark.timeout(CLI_TEST_TIMEOUT * 4)
@pytest.mark.filterwarnings("ignore:implicitly cleaning up.*404")
def test_clifail_bad_url(
self, run_cmdline_test, misc_info, http_inv_url_template, scratch_path
):
Expand All @@ -152,7 +153,7 @@ def test_clifail_bad_url(

@pytest.mark.timeout(CLI_TEST_TIMEOUT * 4)
def test_clifail_url_no_leading_http(self, run_cmdline_test, scratch_path):
"""Confirm proper error behavior when a URL w/o leading 'http://' is passed."""
"""Confirm proper error behavior when a URL w/o leading scheme is passed."""
with stdio_mgr() as (in_, out_, err_):
run_cmdline_test(
[
Expand Down Expand Up @@ -216,15 +217,16 @@ def test_cli_suggest_from_url(
@pytest.mark.parametrize(
"url",
[
"http://sphobjinv.readthedocs.io/en/v2.0/modules/",
"http://sphobjinv.readthedocs.io/en/v2.0/modules/cmdline.html",
"https://sphobjinv.readthedocs.io/en/v2.0/modules/",
"https://sphobjinv.readthedocs.io/en/v2.0/modules/cmdline.html",
(
"http://sphobjinv.readthedocs.io/en/v2.0/modules/"
"https://sphobjinv.readthedocs.io/en/v2.0/modules/"
"cmdline.html#sphobjinv.cmdline.do_convert"
),
],
)
@pytest.mark.timeout(CLI_TEST_TIMEOUT * 4)
@pytest.mark.filterwarnings("ignore:implicitly cleaning up.*404")
def test_cli_suggest_from_docset_urls(self, url, run_cmdline_test, check):
"""Confirm reST-only suggest output works from URLs within a docset."""
with stdio_mgr() as (in_, out_, err_):
Expand All @@ -233,18 +235,18 @@ def test_cli_suggest_from_docset_urls(self, url, run_cmdline_test, check):
check.is_true(p_inventory.search(out_.getvalue()))
check.is_in("LIKELY", err_.getvalue())
check.is_in(
"(http://sphobjinv.readthedocs.io/en/v2.0/, None)", err_.getvalue()
"(https://sphobjinv.readthedocs.io/en/v2.0/, None)", err_.getvalue()
)

@pytest.mark.timeout(CLI_TEST_TIMEOUT * 4)
def test_cli_suggest_from_typical_objinv_url(self, run_cmdline_test, check):
"""Confirm reST-only suggest works for direct objects.inv URL."""
url = "http://sphobjinv.readthedocs.io/en/v2.0/objects.inv"
url = "https://sphobjinv.readthedocs.io/en/v2.0/objects.inv"
with stdio_mgr() as (in_, out_, err_):
run_cmdline_test(["suggest", "-u", url, "inventory", "-at", "50"])

check.is_true(p_inventory.search(out_.getvalue()))
check.is_in("PROBABLY", err_.getvalue())
check.is_in(
"(http://sphobjinv.readthedocs.io/en/v2.0/, None)", err_.getvalue()
"(https://sphobjinv.readthedocs.io/en/v2.0/, None)", err_.getvalue()
)
2 changes: 1 addition & 1 deletion tests/test_cli_textconv.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down
2 changes: 1 addition & 1 deletion tests/test_fixture.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down
2 changes: 1 addition & 1 deletion tests/test_flake8_ext.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down
2 changes: 1 addition & 1 deletion tests/test_intersphinx.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down
2 changes: 1 addition & 1 deletion tests/test_valid_objects.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
\(c) Brian Skinn 2016-2025

**Source Repository**
http://www.github.com/bskinn/sphobjinv
https://github.com/bskinn/sphobjinv

**Documentation**
https://sphobjinv.readthedocs.io/en/stable
Expand Down
9 changes: 5 additions & 4 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@ minversion=2.0
isolated_build=True
envlist=
# Test all Python versions on latest lib versions
py3{10,11,12,13,14}-sphx_latest-attrs_latest-jsch_latest
py3{10,11,12,13t,14,14t}-sphx_latest-attrs_latest-jsch_latest
# Test leading Python version on current in-repo dev lib versions
py313-sphx_dev-attrs_dev-jsch_dev
# Scan across Sphinx versions
# Scan across Sphinx versions (skip 3_x due to a typing import error)
py313-sphx_{1_6_x,1_x,2_x,4_x,5_x,6_x,7_x,8_x,dev}-attrs_latest-jsch_latest
# sphx_3_x is incompatible with py310 due to a typing import. Test on py311 instead.
py311-sphx_3_x-attrs_latest-jsch_latest
# Scan attrs versions
py313-sphx_latest-attrs_{19_2,19_3,20_3,21_3,22_2,23_2,24_3,dev}-jsch_latest
# Scan jsonschema versions
Expand All @@ -30,6 +28,7 @@ envlist=
[testenv]
commands=
python --version
python -c 'import sys; print("GIL: ", end=""); print(getattr(sys, "_is_gil_enabled", lambda : True)())'
pip list
# Want the tox *matrix* to ignore warnings since it's primarily
# a compatibility check. The defaults for bare pytest enable -Werror
Expand Down Expand Up @@ -88,7 +87,9 @@ deps=
platform=linux
basepython=
py314: python3.14
py314t: python3.14t
py313: python3.13
py313t: python3.13t
py312: python3.12
py311: python3.11
py310: python3.10
Expand Down