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
This commit is contained in:
parent
926fc6326f
commit
0ad9f57945
@ -10,6 +10,9 @@ build:
|
|||||||
os: ubuntu-22.04
|
os: ubuntu-22.04
|
||||||
tools:
|
tools:
|
||||||
python: "3.10"
|
python: "3.10"
|
||||||
|
jobs:
|
||||||
|
post_checkout:
|
||||||
|
- git fetch --unshallow || true
|
||||||
|
|
||||||
# Build documentation in the docs/ directory with Sphinx
|
# Build documentation in the docs/ directory with Sphinx
|
||||||
sphinx:
|
sphinx:
|
||||||
|
@ -70,6 +70,7 @@ extensions = [
|
|||||||
'sphinx.ext.napoleon',
|
'sphinx.ext.napoleon',
|
||||||
'oslo_config.sphinxext',
|
'oslo_config.sphinxext',
|
||||||
'oslo_config.sphinxconfiggen',
|
'oslo_config.sphinxconfiggen',
|
||||||
|
'reno.sphinxext',
|
||||||
]
|
]
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
@ -22,3 +22,4 @@ tree <https://opendev.org/x/tobiko/src/branch/master/doc/source>`__.
|
|||||||
reference/index
|
reference/index
|
||||||
etc/index
|
etc/index
|
||||||
miscellaneous/index
|
miscellaneous/index
|
||||||
|
releasenotes/index
|
||||||
|
1
doc/source/releasenotes
Symbolic link
1
doc/source/releasenotes
Symbolic link
@ -0,0 +1 @@
|
|||||||
|
../../releasenotes/source
|
6
releasenotes/source/0.6.0.rst
Normal file
6
releasenotes/source/0.6.0.rst
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
============
|
||||||
|
Tobiko 0.6.0
|
||||||
|
============
|
||||||
|
|
||||||
|
.. release-notes:: Release Notes
|
||||||
|
:version: 0.6.0
|
6
releasenotes/source/0.6.2.rst
Normal file
6
releasenotes/source/0.6.2.rst
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
============
|
||||||
|
Tobiko 0.6.2
|
||||||
|
============
|
||||||
|
|
||||||
|
.. release-notes:: Release Notes
|
||||||
|
:version: 0.6.2
|
6
releasenotes/source/0.7.0.rst
Normal file
6
releasenotes/source/0.7.0.rst
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
============
|
||||||
|
Tobiko 0.7.0
|
||||||
|
============
|
||||||
|
|
||||||
|
.. release-notes:: Release Notes
|
||||||
|
:version: 0.7.0
|
6
releasenotes/source/0.7.1.rst
Normal file
6
releasenotes/source/0.7.1.rst
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
============
|
||||||
|
Tobiko 0.7.1
|
||||||
|
============
|
||||||
|
|
||||||
|
.. release-notes:: Release Notes
|
||||||
|
:version: 0.7.1
|
@ -3,10 +3,14 @@
|
|||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
Welcome to Tobiko Release Notes's documentation!
|
Tobiko Release Notes's
|
||||||
================================================
|
======================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
unreleased
|
unreleased
|
||||||
|
0.7.1
|
||||||
|
0.7.0
|
||||||
|
0.6.2
|
||||||
|
0.6.0
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
==========================
|
==========
|
||||||
Unreleased Release Notes
|
Unreleased
|
||||||
==========================
|
==========
|
||||||
|
|
||||||
.. release-notes::
|
.. release-notes::
|
||||||
|
Loading…
Reference in New Issue
Block a user