8000 chore: Prepare release 1.0.0 · AntoineD/mkdocstrings-python@aead1fd · GitHub
[go: up one dir, main page]

Skip to content

Commit aead1fd

Browse files
committed
chore: Prepare release 1.0.0
1 parent f686f4e commit aead1fd

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

CHANGELOG.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,32 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
66

77
<!-- insertion marker -->
8+
## [1.0.0](https://github.com/mkdocstrings/python/releases/tag/1.0.0) - 2023-05-11
9+
10+
<small>[Compare with 0.10.1](https://github.com/mkdocstrings/python/compare/0.10.1...1.0.0)</small>
11+
12+
### Breaking changes
13+
14+
- The signature of the [`format_signature` filter](https://mkdocstrings.github.io/python/reference/mkdocstrings_handlers/python/rendering/#mkdocstrings_handlers.python.rendering.do_format_signature) has changed.
15+
If you override templates in your project to customize the output,
16+
make sure to update the following templates so that they use
17+
the new filter signature:
18+
19+
- `class.html`
20+
- `expression.html`
21+
- `function.html`
22+
- `signature.html`
23+
24+
You can see how to use the filter in this commit's changes:
25+
[f686f4e4](https://github.com/mkdocstrings/python/commit/f686f4e4599cea64686d4ef4863b507dd096a513).
26+
27+
**We take this as an opportunity to go out of beta and bump the version to 1.0.0.
28+
This will allow users to rely on semantic versioning.**
29+
30+
### Bug Fixes
31+
32+
- Bring compatibility with insiders signature crossrefs feature ([f686f4e](https://github.com/mkdocstrings/python/commit/f686f4e4599cea64686d4ef4863b507dd096a513) by Timothée Mazzucotelli).
33+
834
## [0.10.1](https://github.com/mkdocstrings/python/releases/tag/0.10.1) - 2023-05-07
935

1036
<small>[Compare with 0.10.0](https://github.com/mkdocstrings/python/compare/0.10.0...0.10.1)</small>

0 commit comments

Comments
 (0)
0