Release notes in PR builds

HypothesisWorks · Oct 25, 2020 · 27cf0ee · 27cf0ee
1 parent 4381620
commit 27cf0ee
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
diff --git a/hypothesis-python/docs/changes.rst b/hypothesis-python/docs/changes.rst
@@ -10,6 +10,14 @@ on `PyPI <https://pypi.org/project/hypothesis/>`__.
 Hypothesis 5.x
 ==============
 
+.. only:: has_release_file
+
+    --------------------
+    Current pull request
+    --------------------
+
+    .. include:: ../RELEASE.rst
+
 .. _v5.38.0:
 
 -------------------

diff --git a/hypothesis-python/docs/conf.py b/hypothesis-python/docs/conf.py
@@ -31,6 +31,7 @@
     "sphinx.ext.viewcode",
     "sphinx.ext.intersphinx",
     "hoverxref.extension",
+    "sphinx_selective_exclude.eager_only",
 ]
 
 templates_path = ["_templates"]
@@ -53,6 +54,12 @@
     version = _d["__version__"]
     release = _d["__version__"]
 
+
+def setup(app):
+    if os.path.isfile(os.path.join(os.path.dirname(__file__), "..", "RELEASE.rst")):
+        app.tags.add("has_release_file")
+
+
 language = None
 
 exclude_patterns = ["_build"]

diff --git a/requirements/tools.in b/requirements/tools.in
@@ -26,6 +26,7 @@ restructuredtext-lint
 sphinx
 sphinx-hoverxref
 sphinx-rtd-theme
+sphinx-selective-exclude
 toml
 tox
 twine
diff --git a/requirements/tools.txt b/requirements/tools.txt
@@ -97,6 +97,7 @@ snowballstemmer==2.0.0    # via pydocstyle, sphinx
 sortedcontainers==2.2.2   # via hypothesis (hypothesis-python/setup.py)
 sphinx-hoverxref==0.5b1   # via -r requirements/tools.in
 sphinx-rtd-theme==0.5.0   # via -r requirements/tools.in
+sphinx-selective-exclude==1.0.3  # via -r requirements/tools.in
 sphinx==3.2.1             # via -r requirements/tools.in, sphinx-rtd-theme
 sphinxcontrib-applehelp==1.0.2  # via sphinx
 sphinxcontrib-devhelp==1.0.2  # via sphinx