Add release notes to docs build (#37)

The release notes were always written, just not hooked into the actual Sphinx structure.
Qiskit · Jun 19, 2024 · c399285 · c399285
1 parent 6fb0091
commit c399285
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -9,6 +9,7 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
+    "reno.sphinxext",
     'qiskit_sphinx_theme',
 ]
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

diff --git a/docs/index.rst b/docs/index.rst
@@ -4,7 +4,8 @@ OpenQASM 3 Importer for Qiskit
 .. toctree:: 
     :hidden: 
 
-    Home <self>
+    API documentation <self>
+    release_notes
 
 .. module:: qiskit_qasm3_import
 

diff --git a/docs/release_notes.rst b/docs/release_notes.rst
@@ -0,0 +1,7 @@
+.. _release-notes:
+
+=============
+Release notes
+=============
+
+.. release-notes::