Skip to content

Commit

Permalink
Merge branch 'maintenance/skip-change-note-draft'
Browse files Browse the repository at this point in the history
  • Loading branch information
webknjaz committed Jan 28, 2024
2 parents cba3469 + e17f50d commit 69bbe87
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 5 deletions.
3 changes: 3 additions & 0 deletions CHANGES/8067.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
The Sphinx setup was updated to avoid showing the empty
changelog draft section in the tagged release documentation
builds on Read The Docs -- by :user:`webknjaz`.
13 changes: 8 additions & 5 deletions docs/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,17 @@
Changelog
=========

To be included in v\ |release| (if present)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. only:: not is_release

.. towncrier-draft-entries:: |release| [UNRELEASED DRAFT]
To be included in v\ |release| (if present)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Released versions
^^^^^^^^^^^^^^^^^
.. towncrier-draft-entries:: |release| [UNRELEASED DRAFT]

Released versions
^^^^^^^^^^^^^^^^^

.. include:: ../CHANGES.rst
:start-after: .. towncrier release notes start

.. include:: ../HISTORY.rst
6 changes: 6 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
from pathlib import Path

PROJECT_ROOT_DIR = Path(__file__).parents[1].resolve()
IS_RELEASE_ON_RTD = (
os.getenv("READTHEDOCS", "False") == "True"
and os.environ["READTHEDOCS_VERSION_TYPE"] == "tag"
)
if IS_RELEASE_ON_RTD:
tags.add("is_release")

_docs_path = os.path.dirname(__file__)
_version_path = os.path.abspath(
Expand Down

0 comments on commit 69bbe87

Please sign in to comment.