From c3992850e4bacc146cc03719965a68589fdf1f35 Mon Sep 17 00:00:00 2001 From: Jake Lishman Date: Wed, 19 Jun 2024 09:45:18 +0100 Subject: [PATCH] Add release notes to docs build (#37) The release notes were always written, just not hooked into the actual Sphinx structure. --- docs/conf.py | 1 + docs/index.rst | 3 ++- docs/release_notes.rst | 7 +++++++ 3 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 docs/release_notes.rst diff --git a/docs/conf.py b/docs/conf.py index b358815..f8c6ec4 100644 --- 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 index cc0af37..771b394 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,7 +4,8 @@ OpenQASM 3 Importer for Qiskit .. toctree:: :hidden: - Home + API documentation + release_notes .. module:: qiskit_qasm3_import diff --git a/docs/release_notes.rst b/docs/release_notes.rst new file mode 100644 index 0000000..04739be --- /dev/null +++ b/docs/release_notes.rst @@ -0,0 +1,7 @@ +.. _release-notes: + +============= +Release notes +============= + +.. release-notes::