Skip to content

Commit 491a136

Browse files
authored
Update Sphinx to ^7.1.0 (#828)
Fixes #815 in a more complete way (hopefully)
1 parent b0a6376 commit 491a136

File tree

4 files changed

+24
-27
lines changed

4 files changed

+24
-27
lines changed

CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4343

4444
### Other
4545
* Improve the state of the Python type hints in `basilisp.lang.*` (#797, #784)
46-
* Pin the `sphinxcontrib-*` dependencies versions to fix Read The Docs builds issue (#815)
47-
46+
* Update Sphinx and its associated contrib libraries to `^7.1.0` (#815)
4847

4948
## [v0.1.0b0]
5049
### Added

docs/requirements.txt

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
sphinx~=4.4.0
2-
sphinx-rtd-theme==1.3.0
3-
# The Read the Docs CI build is facing an issue where it doesn't
4-
# automatically identify the correct dependencies versions compatible
5-
# with Sphinx 4.4.0. As a result, we need to explicitly specify these
6-
# versions.
7-
sphinxcontrib-applehelp==1.0.4
8-
sphinxcontrib-devhelp==1.0.2
9-
sphinxcontrib-htmlhelp==2.0.1
10-
sphinxcontrib-qthelp==1.0.3
11-
sphinxcontrib-serializinghtml==1.1.5
1+
# Ensure the Sphinx version remains synchronized with pyproject.toml
2+
# to maintain consistent output during both development and publishing
3+
# on Read The Docs.
4+
sphinx>=7.1.0,<8.0.0
5+
sphinx-rtd-theme>=2.0.0,<3.0.0
6+
sphinxcontrib-applehelp>=1.0.8,<2.0.0
7+
sphinxcontrib-devhelp>=1.0.6,<2.0.0
8+
sphinxcontrib-htmlhelp>=2.0.5,<3.0.0
9+
sphinxcontrib-qthelp>=1.0.7,<2.0.0
10+
sphinxcontrib-serializinghtml>=1.1.10,<2.0.0

pyproject.toml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ isort = "*"
5050
pygments = "*"
5151
pytest = "^7.0.0"
5252
pytest-pycharm = "*"
53-
# Ensure the Sphinx version remains synchronized with
54-
# docs/requirements.txt to maintain consistent output during both
55-
# development and publishing on Read The Docs.
56-
sphinx = "~=4.4.0"
57-
sphinx-rtd-theme = "1.3.0"
53+
# Ensure the Sphinx version remains synchronized with docs/requirements.txt
54+
# to maintain consistent output during both development and publishing on
55+
# Read The Docs.
56+
sphinx = "^7.1.0"
57+
sphinx-rtd-theme = "^2.0.0"
5858
tox = "*"
5959

6060
[tool.poetry.extras]

src/basilisp/contrib/sphinx/autodoc.py

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,10 @@
55
import types
66
from typing import Any, Dict, List, Optional, Tuple, cast
77

8-
from sphinx.ext.autodoc import ( # pylint: disable=no-name-in-module
8+
from sphinx.ext.autodoc import (
99
ClassDocumenter,
1010
Documenter,
1111
ObjectMember,
12-
ObjectMembers,
1312
bool_option,
1413
exclude_members_option,
1514
identity,
@@ -126,7 +125,7 @@ def get_doc(self) -> Optional[List[List[str]]]:
126125
assert self.object is not None
127126
return _get_doc(self.object)
128127

129-
def get_object_members(self, want_all: bool) -> Tuple[bool, ObjectMembers]:
128+
def get_object_members(self, want_all: bool) -> Tuple[bool, List[ObjectMember]]:
130129
assert self.object is not None
131130
interns = self.object.interns
132131

@@ -145,7 +144,7 @@ def get_object_members(self, want_all: bool) -> Tuple[bool, ObjectMembers]:
145144
return False, selected
146145

147146
def filter_members(
148-
self, members: ObjectMembers, want_all: bool
147+
self, members: List[ObjectMember], want_all: bool
149148
) -> List[Tuple[str, Any, bool]]:
150149
filtered = []
151150
for name, val in members:
@@ -269,9 +268,9 @@ def get_sourcename(self) -> str:
269268
return f"{file}:docstring of {self.object}"
270269
return f"docstring of {self.object}"
271270

272-
def get_object_members(self, want_all: bool) -> Tuple[bool, ObjectMembers]:
271+
def get_object_members(self, want_all: bool) -> Tuple[bool, List[ObjectMember]]:
273272
assert self.object is not None
274-
return False, ()
273+
return False, []
275274

276275
def add_directive_header(self, sig: str) -> None:
277276
assert self.object is not None
@@ -364,7 +363,7 @@ def can_document_member(
364363
and member.meta.val_at(_PROTOCOL_KW) is True
365364
)
366365

367-
def get_object_members(self, want_all: bool) -> Tuple[bool, ObjectMembers]:
366+
def get_object_members(self, want_all: bool) -> Tuple[bool, List[ObjectMember]]:
368367
assert self.object is not None
369368
assert want_all
370369
ns = self.object.ns
@@ -382,7 +381,7 @@ def get_object_members(self, want_all: bool) -> Tuple[bool, ObjectMembers]:
382381
)
383382

384383
def filter_members(
385-
self, members: ObjectMembers, want_all: bool
384+
self, members: List[ObjectMember], want_all: bool
386385
) -> List[Tuple[str, Any, bool]]:
387386
filtered = []
388387
for name, val in members:
@@ -419,7 +418,7 @@ def can_document_member(
419418
and issubclass(member.value, IType)
420419
)
421420

422-
def get_object_members(self, want_all: bool) -> Tuple[bool, ObjectMembers]:
421+
def get_object_members(self, want_all: bool) -> Tuple[bool, List[ObjectMember]]:
423422
return ClassDocumenter.get_object_members(self, want_all)
424423

425424

0 commit comments

Comments
 (0)