Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-46777: Release 1.4.2, backport revert sphinx pin #234

Merged
merged 4 commits into from
Oct 15, 2024
Merged

DM-46777: Release 1.4.2, backport revert sphinx pin #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c64a3cc
DM-46777: Add a lower bound on sphinxcontrib-mermaid, revert sphinx pin
fajpunk Oct 15, 2024
ff81b91
mpyp 1.12 doesn't consider this reexported anymore, but it's fine
fajpunk Oct 15, 2024
33728f3
Remove type ignores because they behave differently on this branch fo…
fajpunk Oct 15, 2024
5748fa3
Release 1.4.2
fajpunk Oct 15, 2024
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
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

<!-- scriv-insert-here -->

<a id='changelog-1.4.2'></a>
## 1.4.2 (2024-10-15)

### Bug fixes

- Bump `sphinxcontrib-mermaid` to >= 1, which fixes an incompatibility with sphinx==1.8.1, and allows us to unpin the version of mermaid JS.

<a id='changelog-1.4.1'></a>
## 1.4.1 (2024-10-10)

Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ requires-python = ">=3.11"
dynamic = ["version"]
dependencies = [
"docutils>=0.20", # solves an extra div bug with the bibliography directive
"Sphinx>=7,<8.1.0", # Consistent docutils constraint, mermaid compatibility
"Sphinx>=7", # Consistent docutils constraint
"PyYAML",
"GitPython",
"requests",
Expand Down Expand Up @@ -71,7 +71,7 @@ guide = [
"myst-parser",
"myst-nb",
"markdown-it-py[linkify]",
"sphinxcontrib-mermaid",
"sphinxcontrib-mermaid>=1",
"sphinxext-opengraph",
"sphinxcontrib-redoc",
"sphinxcontrib-jquery",
Expand Down
5 changes: 0 additions & 5 deletions src/documenteer/conf/guide.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@
"myst_enable_extensions",
# MERMAID
"mermaid_output_format",
"mermaid_version",
# OPENGRAPH
"ogp_site_url",
"ogp_site_name",
Expand Down Expand Up @@ -398,10 +397,6 @@
# Mermaid CLI installation
mermaid_output_format = "raw"

# Temporary workaround for not getting mermaid 10 successfully from unpkg
# https://github.com/mgaitan/sphinxcontrib-mermaid/issues/110
mermaid_version = "9.4.0"

# ============================================================================
# #OPENGRAPH OpenGraph diagram support
# https://github.com/wpilibsuite/sphinxext-opengraph
Expand Down
9 changes: 2 additions & 7 deletions src/documenteer/stackdocs/doxygen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
"""Configuration and execution of Doxygen at the stack level.
"""
"""Configuration and execution of Doxygen at the stack level."""

__all__ = [
"DoxygenConfiguration",
Expand Down Expand Up @@ -333,11 +332,7 @@ def render(self) -> str:
self._render_path_list(lines, tag_name, value)
elif tag_field.type == List[str]:
self._render_str_list(lines, tag_name, value)
elif (
tag_field.type == Path
or tag_field.type
== Optional[Path] # type: ignore[comparison-overlap]
):
elif tag_field.type == Path or tag_field.type == Optional[Path]:
self._render_path(lines, tag_name, value)
return "\n".join(lines) + "\n"

Expand Down
Loading