From af54e475132e4083693685fb75757b7ed3e13646 Mon Sep 17 00:00:00 2001
From: lpiwowar <lpiwowar@redhat.com>
Date: Tue, 26 Oct 2021 13:06:46 +0200
Subject: [PATCH] Make release notes part of the documentation

Publishing documentation (including release notes) to docs.openstack.org
is not expected from non openstack/* projects.

This patch ensures that release notes are published to docs.opendev.org
together with tempestconf documentation.

Merging of the release notes with tempestconf documentation is
done using symlink created in the docs/source folder.

Change-Id: I042305f7fdbceb576d7e8d41297111f11caced99
---
 doc/source/conf.py            |  2 +-
 doc/source/index.rst          |  2 +-
 releasenotes/source/index.rst |  6 +++---
 tox.ini                       | 15 ++++++++++++---
 4 files changed, 17 insertions(+), 8 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index c8d334ec..f70c6dce 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
 # -- General configuration ----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -20,6 +19,7 @@
 extensions = [
     'openstackdocstheme',
     #'sphinx.ext.intersphinx',
+    'reno.sphinxext',
     'sphinx.ext.autodoc',
     'sphinxcontrib.rsvgconverter',
     'sphinxarg.ext'
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 0c9d5856..cdca9245 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -27,7 +27,7 @@ Content:
    user/index
    admin/index
    contributor/index
-
+   releasenotes/index
 
 * :ref:`search`
 
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index c2d4ac8f..e58c2f37 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -1,6 +1,6 @@
-============================================
- python-tempestconf Release Notes
-============================================
+=============
+Release Notes
+=============
 
 .. toctree::
    :maxdepth: 1
diff --git a/tox.ini b/tox.ini
index 28a917d6..4131998d 100644
--- a/tox.ini
+++ b/tox.ini
@@ -42,15 +42,24 @@ commands =
 
 [testenv:docs]
 deps = -r{toxinidir}/doc/requirements.txt
-commands = sphinx-build -b html doc/source doc/build/html
-
+allowlist_externals =
+   ln
+   rm
+commands =
+   ln -s ../../releasenotes/source doc/source/releasenotes
+   sphinx-build -b html doc/source doc/build/html
+   rm -f doc/source/releasenotes
 [testenv:pdf-docs]
 deps = {[testenv:docs]deps}
 allowlist_externals =
+   ln
+   rm
    make
 commands =
-   sphinx-build -W -b latex doc/source doc/build/pdf
+   ln -s ../../releasenotes/source doc/source/releasenotes
+   sphinx-build -b latex doc/source doc/build/pdf
    make -C doc/build/pdf
+   rm -f doc/source/releasenotes
 
 [testenv:releasenotes]
 deps = -r{toxinidir}/doc/requirements.txt