DOC: Add changelog to the documentation

airspeed-velocity · Feb 11, 2024 · ee6c734 · ee6c734
1 parent 26a3fcb
commit ee6c734
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -162,3 +162,5 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 .pdm-python
+/docs/source/CHANGELOG.md
+/docs/html/
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -56,3 +56,14 @@
     "source_branch": "main",
     "source_directory": "docs/",
 }
+
+
+# ------------- Copying things
+import os
+import shutil
+
+docs_source_dir = os.path.abspath(os.path.dirname(__file__))
+project_root_dir = os.path.abspath(os.path.join(docs_source_dir, '..', '..'))
+changelog_src = os.path.join(project_root_dir, 'CHANGELOG.md')
+changelog_dest = os.path.join(docs_source_dir, 'CHANGELOG.md')
+shutil.copyfile(changelog_src, changelog_dest)
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -23,6 +23,7 @@ measure and analyze the performance of your Python packages.
 :caption: Contents
 
 apidocs/index
+CHANGELOG
 ```
 
 ## Indices and tables