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
2 changes: 1 addition & 1 deletion RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ All upgrading should be done via the migration script or regenerating the templa

### Cookiecutter template

<!-- Here bug fixes for cookiecutter specifically -->
- Fixed a compatibility issue in the macros doc script with `mkdocsstrings` 0.28.
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ def _hook_macros_plugin(env: macros.MacrosPlugin) -> None:
update_env = python_handler.update_env

# override the `update_env` method of the Python handler
def patched_update_env(markdown: md.Markdown, config: dict[str, Any]) -> None:
update_env(markdown, config)
def patched_update_env(md: md.Markdown, config: dict[str, Any]) -> None:
update_env(md=md, config=config)

# get the `convert_markdown` filter of the env
convert_markdown = python_handler.env.filters["convert_markdown"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ dev-mkdocs = [
"mkdocs-literate-nav == 0.6.1",
"mkdocs-macros-plugin == 1.3.7",
"mkdocs-material == 9.5.45",
"mkdocstrings[python] == 0.27.0",
"mkdocstrings-python == 1.12.2",
"mkdocstrings[python] == 0.28.0",
"mkdocstrings-python == 1.14.0",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.11.0",
]
dev-mypy = [
Expand Down
4 changes: 2 additions & 2 deletions docs/_scripts/macros.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ def _hook_macros_plugin(env: macros.MacrosPlugin) -> None:
update_env = python_handler.update_env

# override the `update_env` method of the Python handler
def patched_update_env(markdown: md.Markdown, config: dict[str, Any]) -> None:
update_env(markdown, config)
def patched_update_env(md: md.Markdown, config: dict[str, Any]) -> None:
update_env(md=md, config=config)

# get the `convert_markdown` filter of the env
convert_markdown = python_handler.env.filters["convert_markdown"]
Expand Down
20 changes: 10 additions & 10 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Copyright © 2023 Frequenz Energy-as-a-Service GmbH

[build-system]
requires = ["setuptools == 75.6.0", "setuptools_scm[toml] == 8.1.0"]
requires = ["setuptools == 75.8.0", "setuptools_scm[toml] == 8.1.0"]
build-backend = "setuptools.build_meta"

[project]
Expand Down Expand Up @@ -69,8 +69,8 @@ extra-lint-examples = [
dev-flake8 = [
"flake8 == 7.1.1",
"flake8-docstrings == 1.7.0",
"flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml
"pydoclint == 0.5.14",
"flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml
"pydoclint == 0.6.0",
"pydocstyle == 6.3.0",
]
dev-formatting = ["black == 24.10.0", "isort == 5.13.2"]
Expand All @@ -81,13 +81,13 @@ dev-mkdocs = [
"mkdocs-gen-files == 0.5.0",
"mkdocs-literate-nav == 0.6.1",
"mkdocs-macros-plugin == 1.3.7",
"mkdocs-material == 9.5.49",
"mkdocstrings[python] == 0.27.0",
"mkdocs-material == 9.6.2",
"mkdocstrings[python] == 0.28.0",
"mkdocstrings-python == 1.13.0",
]
dev-mypy = [
"mypy == 1.14.1",
"types-setuptools >= 67.6.0, < 76", # Should match the build dependency
"types-setuptools >= 67.6.0, < 76", # Should match the build dependency
"types-Markdown == 3.7.0.20241204",
"types-PyYAML == 6.0.12.20241230",
"types-babel == 2.11.0.15",
Expand All @@ -100,14 +100,14 @@ dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
# For checking the noxfile, docs/ script, and tests
"frequenz-repo-config[dev-mkdocs,dev-noxfile,dev-pytest]",
"setuptools >= 67.6.0, < 76", # Should match the build dependency
"setuptools >= 67.6.0, < 76", # Should match the build dependency
]
dev-pytest = [
"pytest == 8.3.4",
"pylint == 3.3.3", # We need this to check for the examples
"pylint == 3.3.4", # We need this to check for the examples
"cookiecutter == 2.6.0", # For checking the cookiecutter scripts
"jinja2 == 3.1.5", # For checking the cookiecutter scripts
"sybil >= 6.1.1, < 10", # Should be consistent with the extra-lint-examples dependency
"jinja2 == 3.1.5", # For checking the cookiecutter scripts
"sybil >= 6.1.1, < 10", # Should be consistent with the extra-lint-examples dependency
]
dev = [
"frequenz-repo-config[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ def _hook_macros_plugin(env: macros.MacrosPlugin) -> None:
update_env = python_handler.update_env

# override the `update_env` method of the Python handler
def patched_update_env(markdown: md.Markdown, config: dict[str, Any]) -> None:
update_env(markdown, config)
def patched_update_env(md: md.Markdown, config: dict[str, Any]) -> None:
update_env(md=md, config=config)

# get the `convert_markdown` filter of the env
convert_markdown = python_handler.env.filters["convert_markdown"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ dev-mkdocs = [
"mkdocs-literate-nav == 0.6.1",
"mkdocs-macros-plugin == 1.3.7",
"mkdocs-material == 9.5.45",
"mkdocstrings[python] == 0.27.0",
"mkdocstrings-python == 1.12.2",
"mkdocstrings[python] == 0.28.0",
"mkdocstrings-python == 1.14.0",
"frequenz-repo-config[actor] == 0.11.0",
]
dev-mypy = [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ def _hook_macros_plugin(env: macros.MacrosPlugin) -> None:
update_env = python_handler.update_env

# override the `update_env` method of the Python handler
def patched_update_env(markdown: md.Markdown, config: dict[str, Any]) -> None:
update_env(markdown, config)
def patched_update_env(md: md.Markdown, config: dict[str, Any]) -> None:
update_env(md=md, config=config)

# get the `convert_markdown` filter of the env
convert_markdown = python_handler.env.filters["convert_markdown"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ dev-mkdocs = [
"mkdocs-literate-nav == 0.6.1",
"mkdocs-macros-plugin == 1.3.7",
"mkdocs-material == 9.5.45",
"mkdocstrings[python] == 0.27.0",
"mkdocstrings-python == 1.12.2",
"mkdocstrings[python] == 0.28.0",
"mkdocstrings-python == 1.14.0",
"frequenz-repo-config[api] == 0.11.0",
]
dev-mypy = [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ def _hook_macros_plugin(env: macros.MacrosPlugin) -> None:
update_env = python_handler.update_env

# override the `update_env` method of the Python handler
def patched_update_env(markdown: md.Markdown, config: dict[str, Any]) -> None:
update_env(markdown, config)
def patched_update_env(md: md.Markdown, config: dict[str, Any]) -> None:
update_env(md=md, config=config)

# get the `convert_markdown` filter of the env
convert_markdown = python_handler.env.filters["convert_markdown"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ dev-mkdocs = [
"mkdocs-literate-nav == 0.6.1",
"mkdocs-macros-plugin == 1.3.7",
"mkdocs-material == 9.5.45",
"mkdocstrings[python] == 0.27.0",
"mkdocstrings-python == 1.12.2",
"mkdocstrings[python] == 0.28.0",
"mkdocstrings-python == 1.14.0",
"frequenz-repo-config[app] == 0.11.0",
]
dev-mypy = [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ def _hook_macros_plugin(env: macros.MacrosPlugin) -> None:
update_env = python_handler.update_env

# override the `update_env` method of the Python handler
def patched_update_env(markdown: md.Markdown, config: dict[str, Any]) -> None:
update_env(markdown, config)
def patched_update_env(md: md.Markdown, config: dict[str, Any]) -> None:
update_env(md=md, config=config)

# get the `convert_markdown` filter of the env
convert_markdown = python_handler.env.filters["convert_markdown"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ dev-mkdocs = [
"mkdocs-literate-nav == 0.6.1",
"mkdocs-macros-plugin == 1.3.7",
"mkdocs-material == 9.5.45",
"mkdocstrings[python] == 0.27.0",
"mkdocstrings-python == 1.12.2",
"mkdocstrings[python] == 0.28.0",
"mkdocstrings-python == 1.14.0",
"frequenz-repo-config[lib] == 0.11.0",
]
dev-mypy = [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ def _hook_macros_plugin(env: macros.MacrosPlugin) -> None:
update_env = python_handler.update_env

# override the `update_env` method of the Python handler
def patched_update_env(markdown: md.Markdown, config: dict[str, Any]) -> None:
update_env(markdown, config)
def patched_update_env(md: md.Markdown, config: dict[str, Any]) -> None:
update_env(md=md, config=config)

# get the `convert_markdown` filter of the env
convert_markdown = python_handler.env.filters["convert_markdown"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ dev-mkdocs = [
"mkdocs-literate-nav == 0.6.1",
"mkdocs-macros-plugin == 1.3.7",
"mkdocs-material == 9.5.45",
"mkdocstrings[python] == 0.27.0",
"mkdocstrings-python == 1.12.2",
"mkdocstrings[python] == 0.28.0",
"mkdocstrings-python == 1.14.0",
"frequenz-repo-config[model] == 0.11.0",
]
dev-mypy = [
Expand Down