docs: include readme + changelog

avengineers · Jul 3, 2024 · 1531a4b · 1531a4b
1 parent afb83a2
commit 1531a4b
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/docs/about/_changelog.md b/docs/about/_changelog.md
@@ -0,0 +1,4 @@
+```{include} ../../CHANGELOG.md
+:relative-docs: docs/
+:relative-images:
+```
diff --git a/docs/about/_readme.md b/docs/about/_readme.md
@@ -0,0 +1,4 @@
+```{include} ../../README.md
+:relative-docs: docs/
+:relative-images:
+```
diff --git a/docs/about/index.rst b/docs/about/index.rst
@@ -1,4 +1,8 @@
 📄 About
 ********
 
-.. mdinclude:: ../../CHANGELOG.md
+.. toctree::
+    :maxdepth: 1
+
+    _readme.md
+    _changelog.md