Skip to content

Commit 6b24b94

Browse files
committed
chore: loosen docs tooling bounds, rename mkdocstrings 'import' to 'inventories'
Drop the upper bounds on the documentation groups, let ruff format Markdown again, and upgrade the lock to the latest stable releases. mkdocstrings-python >=1.14 supports the 'inventories' key that replaces the removed 'import'.
1 parent 3b9b21d commit 6b24b94

3 files changed

Lines changed: 117 additions & 92 deletions

File tree

‎mkdocs.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ plugins:
4848
python:
4949
options:
5050
show_root_heading: true
51-
import:
51+
inventories:
5252
- https://docs.python-requests.org/en/master/objects.inv
5353
- git-revision-date-localized
5454
- mike

‎pyproject.toml‎

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -54,23 +54,18 @@ crypto-eth-addresses = ["eth-hash[pycryptodome]>=0.7.0"]
5454
##############################
5555

5656
[dependency-groups]
57-
# The documentation and man page generation tooling is deliberately held to the versions
58-
# that produce the published output (the man page ships in distro packages). Newer
59-
# releases change the rendered output (e.g. man page markup, bundled pandoc) or break the
60-
# mkdocs configuration. Raise these bounds only together with a review of the regenerated
61-
# `docs/` and man page.
6257
docs-offline = [
63-
"myst-parser>=3.0.1,<4",
64-
"pypandoc-binary>=1.13,<1.14",
65-
"sphinx>=7.1.2,<7.2",
66-
"furo>=2024.8.6,<2025",
58+
"myst-parser>=3.0.1",
59+
"pypandoc-binary>=1.13",
60+
"sphinx>=7.1.2",
61+
"furo>=2024.8.6",
6762
]
6863
docs-online = [
69-
"mkdocs>=1.6.1,<2",
64+
"mkdocs>=1.6.1",
7065
"mkdocs-git-revision-date-localized-plugin>=1.2.7",
71-
"mkdocs-material>=9.5.34,<10",
72-
"mkdocstrings[python]>=0.26.0,<1",
73-
"mkdocstrings-python>=1.10.5,<2",
66+
"mkdocs-material>=9.5.34",
67+
"mkdocstrings[python]>=0.26.0",
68+
"mkdocstrings-python>=1.14.0", # `inventories` option replaces `import`
7469
"mike>=2.1.3",
7570
]
7671
package = ["build>=1.2.1"]
@@ -81,7 +76,7 @@ tooling = [
8176
"ruff>=0.6.3",
8277
"pyright>=1.1.378",
8378
"pytest>=9.0.3",
84-
"pypandoc-binary>=1.13,<1.14", # helps with type checking
79+
"pypandoc-binary>=1.13", # helps with type checking
8580
]
8681

8782
####################
@@ -151,11 +146,6 @@ line-length = 100
151146
target-version = "py311"
152147
extend-exclude = ["**/__pycache__", ".pytest_cache", "site"]
153148

154-
[tool.ruff.format]
155-
# Markdown files under docs/ are sources for the generated documentation and man page;
156-
# keep ruff (which can format Python code blocks in Markdown) away from them.
157-
exclude = ["*.md"]
158-
159149
[tool.ruff.lint.isort]
160150
# case-sensitive = true
161151
combine-as-imports = true

0 commit comments

Comments
 (0)