openinfra/python-tempestconf
Code Issues Proposed changes

Make release notes part of the documentation

Browse Source 
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
This commit is contained in:
lpiwowar 2021-10-26 13:06:46 +02:00 committed by Martin Kopec
parent dbf3e3681b
commit af54e47513
4 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/conf.py
View File

@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# -- General configuration ---------------------------------------------------- # -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
@ -20,6 +19,7 @@
extensions = [ extensions = [
'openstackdocstheme', 'openstackdocstheme',
#'sphinx.ext.intersphinx', #'sphinx.ext.intersphinx',
'reno.sphinxext',
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinxcontrib.rsvgconverter', 'sphinxcontrib.rsvgconverter',
'sphinxarg.ext' 'sphinxarg.ext'

2
doc/source/index.rst
View File

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

6
releasenotes/source/index.rst
View File

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

15
tox.ini
View File

@ -42,15 +42,24 @@ commands =
[testenv:docs] [testenv:docs]
deps = -r{toxinidir}/doc/requirements.txt 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] [testenv:pdf-docs]
deps = {[testenv:docs]deps} deps = {[testenv:docs]deps}
allowlist_externals = allowlist_externals =
ln
rm
make make
commands = 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 make -C doc/build/pdf
rm -f doc/source/releasenotes
[testenv:releasenotes] [testenv:releasenotes]
deps = -r{toxinidir}/doc/requirements.txt deps = -r{toxinidir}/doc/requirements.txt