Merge pull request #129 from umami-hep/update-docs

Docs: use link to changelog
umami-hep · Sep 20, 2022 · bf74557 · bf74557
2 parents c8f0054 + 471c5a2
commit bf74557
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -81,6 +81,12 @@
 
 html_theme = "pydata_sphinx_theme"
 html_theme_options = {
+    "external_links": [
+        {
+            "url": "https://github.com/umami-hep/puma/blob/main/changelog.md",
+            "name": "Changelog",
+        },
+    ],
     "logo": {
         "text": "puma documentation",
     },

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,7 +10,6 @@
    Quickstart <self>
    examples/index.rst
    dev_guidelines/index.rst
-   ../../changelog.md
 
 Indices and tables
 ==================

diff --git a/docs/sphinx_build_multiversion.py b/docs/sphinx_build_multiversion.py
@@ -62,7 +62,6 @@ def main():
     # copy the latest conf.py, since we want to use that configuration for all the
     # docs versions that are built
     copy("docs/source/conf.py", "./conf_latest.py")
-    copy("changelog.md", "docs/source/changelog.md")
 
     # build docs for main branch no matter what versions are present in the switcher
     # (this is kind of a safety measure to make sure the main branch docs are built