perf(docs): attach CHANGELOG.md to sphinx docs

Close #25 Signed-off-by: msclock <msclock@qq.com>
serious-scaffold · Oct 27, 2023 · 88cf600 · 88cf600
1 parent c1a8017
commit 88cf600
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1,4 @@
+# Changelog
+
+```{include} ../CHANGELOG.md
+```
diff --git a/docs/index.md b/docs/index.md
@@ -4,6 +4,7 @@
 :hidden:
 Overview <self>
 cmake_workflow
+changelog
 api
 coverage/index
 ```

diff --git a/template/[% if docs_type == 'sphinx' %]docs[% endif %]/changelog.md b/template/[% if docs_type == 'sphinx' %]docs[% endif %]/changelog.md
@@ -0,0 +1,4 @@
+# Changelog
+
+```{include} ../CHANGELOG.md
+```
diff --git a/template/[% if docs_type == 'sphinx' %]docs[% endif %]/index.md.jinja b/template/[% if docs_type == 'sphinx' %]docs[% endif %]/index.md.jinja
@@ -4,6 +4,7 @@
 :hidden:
 Overview <self>
 cmake_workflow
+changelog
 api
 coverage/index
 ```