Browse Source

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
changes/74/815474/10
lpiwowar 3 months ago
committed by Martin Kopec
parent
commit
af54e47513
  1. 2
      doc/source/conf.py
  2. 2
      doc/source/index.rst
  3. 6
      releasenotes/source/index.rst
  4. 15
      tox.ini

2
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'

2
doc/source/index.rst

@ -27,7 +27,7 @@ Content:
user/index
admin/index
contributor/index
releasenotes/index
* :ref:`search`

6
releasenotes/source/index.rst

@ -1,6 +1,6 @@
============================================
python-tempestconf Release Notes
============================================
=============
Release Notes
=============
.. toctree::
:maxdepth: 1

15
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

Loading…
Cancel
Save