Include Github releases in docs (#194)

* Include Github releases in docs Uses https://sphinx-github-changelog.readthedocs.io/en/latest/ to pull the changelog from Github Releases. Requires `SPHINX_GITHUB_CHANGELOG_TOKEN` to be set to build the changelog. * Remove documentation from title * Shorten the docs title
xpublish-community · May 12, 2023 · 2056222 · 2056222
1 parent 9bb549e
commit 2056222
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 1 deletion.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -5,3 +5,4 @@ sphinx-autodoc-typehints
 autodoc_pydantic
 myst-nb
 sphinx-design
+sphinx_github_changelog
diff --git a/docs/source/changelog.md b/docs/source/changelog.md
@@ -0,0 +1,9 @@
+# Changelog
+
+```{changelog}
+---
+changelog-url: https://xpublish.readthedocs.io/en/latest/changelog.html
+github: https://github.com/xpublish-community/xpublish/releases
+pypi: https://pypi.org/project/xpublish/
+---
+```
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -48,6 +48,7 @@
     'sphinx_autodoc_typehints',
     'sphinx_design',
     'myst_parser',
+    'sphinx_github_changelog',
 ]
 
 myst_enable_extensions = []
@@ -151,6 +152,7 @@
         }
     ],
     'use_edit_page_button': True,
+    'header_links_before_dropdown': 4,
 }
 
 html_context = {
@@ -165,7 +167,7 @@
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-# html_title = None
+html_title = f'{project} {version}'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 # html_short_title = None

diff --git a/docs/source/index.md b/docs/source/index.md
@@ -115,6 +115,7 @@ user-guide/index
 api
 ecosystem/index
 Contributing <contributing>
+changelog
 ```
 
 ## Feedback