Merge pull request #151 from pydanny/add-changelog-to-site

Add changelog to docs site
pydanny · Oct 30, 2023 · 77b9137 · 77b9137
2 parents d8de597 + 059c731
commit 77b9137
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -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
 
 ---
@@ -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
@@ -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)
@@ -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
 
 

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1,8 @@
+# Changelog
+
+{%
+   include-markdown "../CHANGELOG.md"
+   start="<!--start-->"
+   end="<!--end-->"
+   heading-offset=1
+%}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -36,4 +36,5 @@ nav:
   - Activation: activation.md
   - Usage: usage.ipynb
   - Contributing: contributing.md
-  - Releasing: releasing.md
+  - Releasing: releasing.md
+  - Changelog: changelog.md
diff --git a/utils/update_changelog.py b/utils/update_changelog.py
@@ -21,6 +21,7 @@ def main() -> None:
 
 {previous_changelog}
 """
+    new_changelog = new_changelog.replace("## ##", "##")
 
     pathlib.Path("CHANGELOG.md").write_text(new_changelog)