Add changelog to the documentation

It4innovations · Oct 21, 2024 · 19e22ac · 19e22ac
1 parent 92eaf62
commit 19e22ac
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1,7 @@
+# Changelog
+
+This page contains the historical record of changes in various version of HyperQueue. You can use
+the select box in the top left corner of the page to view the documentation of a specific HyperQueue
+version.
+
+--8<-- "CHANGELOG.md"
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -43,6 +43,7 @@ nav:
       - Submitting jobs: python/submit.md
       - Dependencies: python/dependencies.md
       - API reference: python/apidoc/
+  - Changelog: changelog.md
   - FAQ: faq.md
   - Comparison With Other Tools: other-tools.md
 
@@ -66,6 +67,8 @@ markdown_extensions:
   - pymdownx.superfences
   - pymdownx.tabbed:
       alternate_style: true
+  - pymdownx.snippets:
+      base_path: .
   - footnotes
   - admonition