From 0ad9f579457cd40116701df9c572fb8a09bf63a9 Mon Sep 17 00:00:00 2001 From: Slawek Kaplonski Date: Sun, 1 Dec 2024 12:49:43 +0100 Subject: [PATCH] Include release notes in the main docs page of Tobiko This patch adds link to the release notes in the main doc source directory to include it in the build of the main documentation page. With that release notes are included at the main page of the Tobiko documentation. Additionally this patch adds missing files for the already released versions of the Tobiko which have release notes written. From now on it is required to add new file in the releasenotes/source/ directory for every new version which will be released. Related: #TOBIKO-13 Change-Id: I053b4bac735139b19ce06f166b4c99c218002821 --- .readthedocs.yaml | 3 +++ doc/source/conf.py | 1 + doc/source/content.rst | 1 + doc/source/releasenotes | 1 + releasenotes/source/0.6.0.rst | 6 ++++++ releasenotes/source/0.6.2.rst | 6 ++++++ releasenotes/source/0.7.0.rst | 6 ++++++ releasenotes/source/0.7.1.rst | 6 ++++++ releasenotes/source/index.rst | 8 ++++++-- releasenotes/source/unreleased.rst | 6 +++--- 10 files changed, 39 insertions(+), 5 deletions(-) create mode 120000 doc/source/releasenotes create mode 100644 releasenotes/source/0.6.0.rst create mode 100644 releasenotes/source/0.6.2.rst create mode 100644 releasenotes/source/0.7.0.rst create mode 100644 releasenotes/source/0.7.1.rst diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 9cef7684d..ae59be8b6 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,6 +10,9 @@ build: os: ubuntu-22.04 tools: python: "3.10" + jobs: + post_checkout: + - git fetch --unshallow || true # Build documentation in the docs/ directory with Sphinx sphinx: diff --git a/doc/source/conf.py b/doc/source/conf.py index 58134afa0..eb5f18a28 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -70,6 +70,7 @@ extensions = [ 'sphinx.ext.napoleon', 'oslo_config.sphinxext', 'oslo_config.sphinxconfiggen', + 'reno.sphinxext', ] # Add any paths that contain templates here, relative to this directory. diff --git a/doc/source/content.rst b/doc/source/content.rst index a5d7fb23a..4171bff32 100644 --- a/doc/source/content.rst +++ b/doc/source/content.rst @@ -22,3 +22,4 @@ tree `__. reference/index etc/index miscellaneous/index + releasenotes/index diff --git a/doc/source/releasenotes b/doc/source/releasenotes new file mode 120000 index 000000000..03f5d3232 --- /dev/null +++ b/doc/source/releasenotes @@ -0,0 +1 @@ +../../releasenotes/source \ No newline at end of file diff --git a/releasenotes/source/0.6.0.rst b/releasenotes/source/0.6.0.rst new file mode 100644 index 000000000..9ade947da --- /dev/null +++ b/releasenotes/source/0.6.0.rst @@ -0,0 +1,6 @@ +============ +Tobiko 0.6.0 +============ + +.. release-notes:: Release Notes + :version: 0.6.0 diff --git a/releasenotes/source/0.6.2.rst b/releasenotes/source/0.6.2.rst new file mode 100644 index 000000000..7a605c0e5 --- /dev/null +++ b/releasenotes/source/0.6.2.rst @@ -0,0 +1,6 @@ +============ +Tobiko 0.6.2 +============ + +.. release-notes:: Release Notes + :version: 0.6.2 diff --git a/releasenotes/source/0.7.0.rst b/releasenotes/source/0.7.0.rst new file mode 100644 index 000000000..e4d1d89dd --- /dev/null +++ b/releasenotes/source/0.7.0.rst @@ -0,0 +1,6 @@ +============ +Tobiko 0.7.0 +============ + +.. release-notes:: Release Notes + :version: 0.7.0 diff --git a/releasenotes/source/0.7.1.rst b/releasenotes/source/0.7.1.rst new file mode 100644 index 000000000..280a93620 --- /dev/null +++ b/releasenotes/source/0.7.1.rst @@ -0,0 +1,6 @@ +============ +Tobiko 0.7.1 +============ + +.. release-notes:: Release Notes + :version: 0.7.1 diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index a9654ab34..11e72b835 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -3,10 +3,14 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Tobiko Release Notes's documentation! -================================================ +Tobiko Release Notes's +====================== .. toctree:: :maxdepth: 1 unreleased + 0.7.1 + 0.7.0 + 0.6.2 + 0.6.0 diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst index 5860a4691..cfbd86fd9 100644 --- a/releasenotes/source/unreleased.rst +++ b/releasenotes/source/unreleased.rst @@ -1,5 +1,5 @@ -========================== - Unreleased Release Notes -========================== +========== +Unreleased +========== .. release-notes::