Skip to content

Commit 69bbe87

Browse files
committed
Merge branch 'maintenance/skip-change-note-draft'
PR #8069
2 parents cba3469 + e17f50d commit 69bbe87

File tree

3 files changed

+17
-5
lines changed

3 files changed

+17
-5
lines changed

CHANGES/8067.doc.rst

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
The Sphinx setup was updated to avoid showing the empty
2+
changelog draft section in the tagged release documentation
3+
builds on Read The Docs -- by :user:`webknjaz`.

docs/changes.rst

+8-5
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44
Changelog
55
=========
66

7-
To be included in v\ |release| (if present)
8-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7+
.. only:: not is_release
98

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

12-
Released versions
13-
^^^^^^^^^^^^^^^^^
12+
.. towncrier-draft-entries:: |release| [UNRELEASED DRAFT]
13+
14+
Released versions
15+
^^^^^^^^^^^^^^^^^
1416

1517
.. include:: ../CHANGES.rst
18+
:start-after: .. towncrier release notes start
1619

1720
.. include:: ../HISTORY.rst

docs/conf.py

+6
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@
1717
from pathlib import Path
1818

1919
PROJECT_ROOT_DIR = Path(__file__).parents[1].resolve()
20+
IS_RELEASE_ON_RTD = (
21+
os.getenv("READTHEDOCS", "False") == "True"
22+
and os.environ["READTHEDOCS_VERSION_TYPE"] == "tag"
23+
)
24+
if IS_RELEASE_ON_RTD:
25+
tags.add("is_release")
2026

2127
_docs_path = os.path.dirname(__file__)
2228
_version_path = os.path.abspath(

0 commit comments

Comments
 (0)