Merge pull request #2657 from cta-observatory/sphinx-changelog

Use sphinx-changelog
cta-observatory · Nov 27, 2024 · 7a26885 · 7a26885
2 parents 055b62b + 9546ab9
commit 7a26885
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 5 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -207,9 +207,5 @@ jobs:
           git describe --tags
           python -c 'import ctapipe; print(ctapipe.__version__)'
 
-      - name: Produce Changelog
-        run: |
-          towncrier build --yes
-
       - name: Build docs
         run: make doc
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -2,4 +2,8 @@
 Change Log
 **********
 
-.. include:: ../CHANGES.rst
+
+.. changelog::
+   :towncrier: ../
+   :changelog_file: ../CHANGES.rst
+   :towncrier-skip-if-empty:
diff --git a/docs/conf.py b/docs/conf.py
@@ -60,6 +60,7 @@
     "sphinx_design",
     "IPython.sphinxext.ipython_console_highlighting",
     "sphinx_gallery.gen_gallery",
+    "sphinx_changelog",
 ]
 
 

diff --git a/environment.yml b/environment.yml
@@ -40,6 +40,7 @@ dependencies:
   - pydata-sphinx-theme
   - sphinx-design
   - sphinxcontrib-bibtex
+  - sphinx_changelog
   - tomli
   - towncrier
   - tqdm

diff --git a/pyproject.toml b/pyproject.toml
@@ -88,6 +88,7 @@ docs = [
     "sphinx-gallery >= 0.16.0",
     "sphinx_automodapi",
     "sphinxcontrib-bibtex",
+    "sphinx-changelog",
     "tomli; python_version < '3.11'",
 ]