Skip to content

Commit 25258eb

Browse files
committed
Update release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent cac7ea5 commit 25258eb

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

RELEASE_NOTES.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,48 @@
1010

1111
### Cookiecutter template
1212

13-
<!-- Here upgrade steps for cookiecutter specifically -->
13+
- `mkdocs`
14+
15+
- The script `docs/mkdocstrings_autoapi.py` was moved to `docs/_scripts/mkdocstrings.py`.
16+
- Note that now code annotations will be numbered. This is useful to hint about the order one should read the annotations.
17+
- The following files were renamed to keep the documentation directory clean for documentation files:
18+
19+
- `docs/css` -> `docs/_css`
20+
- `docs/overrides` -> `docs/_overrides`
21+
- `logo.png` -> `docs/_img/logo.png`
22+
23+
- CI
24+
25+
- You can now make your branch protection rule only require the "Test with nox" CI job to pass. All the matrix expansions will merge into it, so there is no need to change branch protection rules if matrix elements are added or removed.
1426

1527
## New Features
1628

1729
<!-- Here goes the main new features and examples or instructions on how to use them -->
1830

1931
### Cookiecutter template
2032

21-
<!-- Here new features for cookiecutter specifically -->
33+
- `mkdocs`
34+
35+
- New markdown extensions: [`def_list` / `task_list`](https://squidfunk.github.io/mkdocs-material/reference/lists/) and [`footnotes`](https://squidfunk.github.io/mkdocs-material/reference/footnotes/).
36+
- New [`mkdocs-macros`](https://mkdocs-macros-plugin.readthedocs.io/en/latest/) extension.
37+
- Show inherited attributes in the documentation.
38+
- Make code annotations numbered. This is useful to hint about the order one should read the annotations.
39+
- Updated dependencies.
40+
41+
- CI
42+
43+
- Add CI job to test package installation on multiple platforms (amd64 and arm64).
44+
- Add CI job to run the tests in arm64.
45+
- Add a CI job to *join* all `nox` runs, so only one branch protection rule needs to be used.
2246

2347
## Bug Fixes
2448

2549
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
2650

2751
### Cookiecutter template
2852

29-
<!-- Here bug fixes for cookiecutter specifically -->
53+
- `mkdocs`
54+
55+
- Fixed mermaid diagrams not rendering in the documentation.
56+
- `mypy` ignores for `cookiecutter` have been removed. They should have never be there as generated projects don't use `cookiecutter`.
57+
- `mypy` overrides now are applied to API projects too.

0 commit comments

Comments
 (0)