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.

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

Add changelog to docs site #151

Merged
merged 1 commit into from
Oct 30, 2023
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
19 changes: 8 additions & 11 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
2023-10-22T05:57:56Z by
[@pydanny](https://github.com/pydanny)

## ## What's Changed
Fixing borked release caused by inconsistent PyPI trove classifiers
## What's Changed

Fixing borked release caused by inconsistent PyPI trove classifiers


**Full Changelog**: https://github.com/pydanny/dj-notebook/compare/v0.6.0...v0.6.1

---
Expand All @@ -19,7 +19,7 @@ Fixing borked release caused by inconsistent PyPI trove classifiers
2023-10-22T05:01:55Z by
[@pydanny](https://github.com/pydanny)

## ## What's Changed
## What's Changed
* Add missing read frame example by @pydanny in https://github.com/pydanny/dj-notebook/pull/107
* Raise warning if not run in debug by @skyforest in https://github.com/pydanny/dj-notebook/pull/109
* Added chrisdev to other contributors by @specbeck in https://github.com/pydanny/dj-notebook/pull/110
Expand All @@ -42,15 +42,12 @@ Fixing borked release caused by inconsistent PyPI trove classifiers

---


# CHANGELOG

# [v0.5.0](https://github.com/pydanny/dj-notebook/releases/tag/v0.5.0)

2023-10-10T15:01:07Z by
[@pydanny](https://github.com/pydanny)

## ## What's Changed
## What's Changed

```
plus.model_graph(plus.User)
Expand Down Expand Up @@ -129,7 +126,7 @@ plus.model_graph(plus.User)
2023-09-26T15:24:15Z by
[@pydanny](https://github.com/pydanny)

## ## What's Changed
## What's Changed
* Correct the release notes by @pydanny in https://github.com/pydanny/dj-notebook/pull/26


Expand Down
8 changes: 8 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changelog

{%
include-markdown "../CHANGELOG.md"
start="<!--start-->"
end="<!--end-->"
heading-offset=1
%}
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,5 @@ nav:
- Activation: activation.md
- Usage: usage.ipynb
- Contributing: contributing.md
- Releasing: releasing.md
- Releasing: releasing.md
- Changelog: changelog.md
1 change: 1 addition & 0 deletions utils/update_changelog.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ def main() -> None:

{previous_changelog}
"""
new_changelog = new_changelog.replace("## ##", "##")

pathlib.Path("CHANGELOG.md").write_text(new_changelog)

Expand Down