. You may prefer a
@@ -35,7 +35,7 @@
{%- endif %}
- {% if rtd_version = "latest" %}
+ {% if rtd_version == 'latest' %}
Warning
(rtd_version2) You a viewing the
latest unreleased documentation
From 0d54f020f0cb74c949c8c79a0d132ecda4914ed5 Mon Sep 17 00:00:00 2001
From: Tremain Knight <2108488+tkknight@users.noreply.github.com>
Date: Sun, 14 Feb 2021 17:55:19 +0000
Subject: [PATCH 09/21] removed line
---
docs/src/_templates/layout.html | 20 --------------------
docs/src/conf.py | 1 -
2 files changed, 21 deletions(-)
diff --git a/docs/src/_templates/layout.html b/docs/src/_templates/layout.html
index b69d01d330..d49e013eb1 100644
--- a/docs/src/_templates/layout.html
+++ b/docs/src/_templates/layout.html
@@ -7,24 +7,6 @@
/*---------------------------------------------------------------------------*/
{%- block document %}
-{% if theme_display_version %}
-{%- set nav_version = version %}
-{% if READTHEDOCS and current_version %}
- {%- set nav_version = current_version %}
-{% endif %}
-{% if nav_version %}
-
- {{ nav_version }}
-
-{% endif %}
-{% endif %}
-
-
-DEBUG: theme_display_version = {{ theme_display_version }}
- DEBUG: current_version = {{ current_version }}
- DEBUG: nav_version = {{ nav_version }}
- DEBUG: version = {{ version }}
-
{% if rtd_version == 'latest' %}
(rtd_version1) You a viewing the
latest unreleased documentation
@@ -44,12 +26,10 @@
version.
-
{%- endif %}
{{ super() }}
-
{%- endblock %}
/*---------------------------------------------------------------------------*/
diff --git a/docs/src/conf.py b/docs/src/conf.py
index fddbf17459..ca13bc8687 100644
--- a/docs/src/conf.py
+++ b/docs/src/conf.py
@@ -128,7 +128,6 @@ def autolog(message):
"sphinx_gallery.gen_gallery",
"matplotlib.sphinxext.mathmpl",
"matplotlib.sphinxext.plot_directive",
- "versionwarning.extension",
# better api documentation (custom)
"custom_class_autodoc",
"custom_data_autodoc",
From 1c3efaa0dd74ccb56b291a32f8e3ea52b909a3f1 Mon Sep 17 00:00:00 2001
From: Tremain Knight <2108488+tkknight@users.noreply.github.com>
Date: Sun, 14 Feb 2021 18:16:09 +0000
Subject: [PATCH 10/21] tidy up
---
docs/src/_templates/layout.html | 12 +-----------
docs/src/conf.py | 26 +-------------------------
2 files changed, 2 insertions(+), 36 deletions(-)
diff --git a/docs/src/_templates/layout.html b/docs/src/_templates/layout.html
index d49e013eb1..c67f4f8836 100644
--- a/docs/src/_templates/layout.html
+++ b/docs/src/_templates/layout.html
@@ -7,20 +7,10 @@
/*---------------------------------------------------------------------------*/
{%- block document %}
- {% if rtd_version == 'latest' %}
-
- (rtd_version1) You a viewing the
latest unreleased documentation
-
v{{ version }}. You may prefer a
-
stable
- version.
-
-
- {%- endif %}
-
{% if rtd_version == 'latest' %}
Warning
- (rtd_version2) You a viewing the
latest unreleased documentation
+ You a viewing the
latest unreleased documentation
v{{ version }}. You may prefer a
stable
version.
diff --git a/docs/src/conf.py b/docs/src/conf.py
index ca13bc8687..b91dc2b764 100644
--- a/docs/src/conf.py
+++ b/docs/src/conf.py
@@ -134,30 +134,6 @@ def autolog(message):
# TREMTEST
# "generate_package_rst",
]
-
-# -- sphinx-version-warning extension------------------------------------------
-# See https://sphinx-version-warning.readthedocs.io/en/latest/index.html
-
-versionwarning_messages = {
- "latest": (
- "(exntesion) You a viewing the
latest unreleased documentation "
- "
v{{ version }}. You may prefer a "
- "
stable"
- "version."
- ),
-}
-
-versionwarning_admonition_type = "tip"
-# versionwarning_banner_title = "Tip"
-# versionwarning_body_selector = 'div[itemprop="articleBody"]'
-
-# ===
-# Show warning at top of page
-# versionwarning_body_selector = "div.document"
-# versionwarning_banner_title = ""
-# For debugging locally
-versionwarning_project_version = "latest"
-
# -- panels extension ---------------------------------------------------------
# See https://sphinx-panels.readthedocs.io/en/latest/
@@ -191,7 +167,7 @@ def autolog(message):
# See https://sphinx-copybutton.readthedocs.io/en/latest/
copybutton_prompt_text = ">>> "
-# sphinx.ext.todo configuration
+# sphinx.ext.todo configuration -----------------------------------------------
# See https://www.sphinx-doc.org/en/master/usage/extensions/todo.html
todo_include_todos = True
From da2510f745b670451a36edf98b1c315a93e0fc0e Mon Sep 17 00:00:00 2001
From: Tremain Knight <2108488+tkknight@users.noreply.github.com>
Date: Sun, 14 Feb 2021 18:19:05 +0000
Subject: [PATCH 11/21] tidy comments
---
docs/src/_templates/layout.html | 1 -
docs/src/conf.py | 5 ++---
2 files changed, 2 insertions(+), 4 deletions(-)
diff --git a/docs/src/_templates/layout.html b/docs/src/_templates/layout.html
index c67f4f8836..99ec1ad20e 100644
--- a/docs/src/_templates/layout.html
+++ b/docs/src/_templates/layout.html
@@ -14,7 +14,6 @@
v{{ version }}. You may prefer a
stable
version.
-
{%- endif %}
diff --git a/docs/src/conf.py b/docs/src/conf.py
index b91dc2b764..1129ecb0e7 100644
--- a/docs/src/conf.py
+++ b/docs/src/conf.py
@@ -43,7 +43,7 @@ def autolog(message):
for item, value in os.environ.items():
autolog("[READTHEDOCS] {} = {}".format(item, value))
-# This is the version "name" rtd uses, such as: latest, stable, v3.0.1 etc
+# This is the rtd reference to the version, such as: latest, stable, v3.0.1 etc
rtd_version = os.environ.get("READTHEDOCS_VERSION")
# -- Path setup --------------------------------------------------------------
@@ -131,8 +131,7 @@ def autolog(message):
# better api documentation (custom)
"custom_class_autodoc",
"custom_data_autodoc",
- # TREMTEST
- # "generate_package_rst",
+ "generate_package_rst",
]
# -- panels extension ---------------------------------------------------------
# See https://sphinx-panels.readthedocs.io/en/latest/
From b131337fa2fa304f30af05eaca58696a339216a1 Mon Sep 17 00:00:00 2001
From: Tremain Knight <2108488+tkknight@users.noreply.github.com>
Date: Sun, 14 Feb 2021 18:25:03 +0000
Subject: [PATCH 12/21] debug of pre-existing rtd variables
---
docs/src/_templates/layout.html | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/docs/src/_templates/layout.html b/docs/src/_templates/layout.html
index 99ec1ad20e..51b976f3f8 100644
--- a/docs/src/_templates/layout.html
+++ b/docs/src/_templates/layout.html
@@ -7,6 +7,10 @@
/*---------------------------------------------------------------------------*/
{%- block document %}
+ DEBUG:
+ readthedocs.v1.vcs.type = {{ readthedocs.v1.vcs.type }}
+ readthedocs.v1 = {{ readthedocs.v1 }}
+
{% if rtd_version == 'latest' %}
Warning
From 153fa2c13a54064a417bf5d8fa9fc4cfea9861a0 Mon Sep 17 00:00:00 2001
From: Tremain Knight <2108488+tkknight@users.noreply.github.com>
Date: Sun, 14 Feb 2021 18:42:51 +0000
Subject: [PATCH 13/21] added reminder
---
docs/src/conf.py | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/src/conf.py b/docs/src/conf.py
index 1129ecb0e7..8fb54ea16e 100644
--- a/docs/src/conf.py
+++ b/docs/src/conf.py
@@ -44,6 +44,7 @@ def autolog(message):
autolog("[READTHEDOCS] {} = {}".format(item, value))
# This is the rtd reference to the version, such as: latest, stable, v3.0.1 etc
+# TREMTEST: I may not need to create a variable, see https://docs.readthedocs.io/en/stable/development/design/theme-context.html?highlight=html_
rtd_version = os.environ.get("READTHEDOCS_VERSION")
# -- Path setup --------------------------------------------------------------
From adad28c8f3cc3ff60681219d7007bba2984b11ec Mon Sep 17 00:00:00 2001
From: Tremain Knight <2108488+tkknight@users.noreply.github.com>
Date: Mon, 15 Feb 2021 10:18:30 +0000
Subject: [PATCH 14/21] testing
---
docs/src/_templates/layout.html | 16 +++++++++++++---
1 file changed, 13 insertions(+), 3 deletions(-)
diff --git a/docs/src/_templates/layout.html b/docs/src/_templates/layout.html
index 51b976f3f8..59a8356b4f 100644
--- a/docs/src/_templates/layout.html
+++ b/docs/src/_templates/layout.html
@@ -6,10 +6,20 @@
/*---------------------------------------------------------------------------*/
+{%- block sidebartitle %}
+ {{ super() }}
+
+ FOO!
+{%- endblock %}
+
+/*---------------------------------------------------------------------------*/
+
{%- block document %}
DEBUG:
- readthedocs.v1.vcs.type = {{ readthedocs.v1.vcs.type }}
- readthedocs.v1 = {{ readthedocs.v1 }}
+ {% if readthedocs %}
+ readthedocs.v1.vcs.type = {{ readthedocs.v1.vcs.type }}
+ readthedocs.v1 = {{ readthedocs.v1 }}
+ {%- endif %}
{% if rtd_version == 'latest' %}
@@ -25,7 +35,7 @@
{{ super() }}
{%- endblock %}
-/*---------------------------------------------------------------------------*/
+/*-----------------------------------------------------z----------------------*/
{% block menu %}
{{ super() }}
From 271314a5059c35af95313da3bab6e89df91dc2e8 Mon Sep 17 00:00:00 2001
From: Tremain Knight <2108488+tkknight@users.noreply.github.com>
Date: Mon, 15 Feb 2021 11:07:12 +0000
Subject: [PATCH 15/21] testing still
---
docs/src/_static/theme_override.css | 14 ++++++++++++++
docs/src/_templates/layout.html | 29 ++++++++++++-----------------
docs/src/conf.py | 4 +---
3 files changed, 27 insertions(+), 20 deletions(-)
diff --git a/docs/src/_static/theme_override.css b/docs/src/_static/theme_override.css
index 5edc286630..c56b720f69 100644
--- a/docs/src/_static/theme_override.css
+++ b/docs/src/_static/theme_override.css
@@ -26,3 +26,17 @@ table.docutils td {
word-wrap: break-word;
}
+/* Used for very strong warning */
+#slim-red-box-message {
+ background: #ff0000;
+ box-sizing: border-box;
+ color: #ffffff;
+ font-weight: normal;
+ padding: 0.5em;
+}
+
+#slim-red-box-message a {
+ color: #ffffff;
+ font-weight: normal;
+ text-decoration:underline;
+}
diff --git a/docs/src/_templates/layout.html b/docs/src/_templates/layout.html
index 59a8356b4f..352370375f 100644
--- a/docs/src/_templates/layout.html
+++ b/docs/src/_templates/layout.html
@@ -6,30 +6,25 @@
/*---------------------------------------------------------------------------*/
-{%- block sidebartitle %}
- {{ super() }}
-
- FOO!
-{%- endblock %}
-
-/*---------------------------------------------------------------------------*/
-
{%- block document %}
- DEBUG:
- {% if readthedocs %}
- readthedocs.v1.vcs.type = {{ readthedocs.v1.vcs.type }}
- readthedocs.v1 = {{ readthedocs.v1 }}
- {%- endif %}
{% if rtd_version == 'latest' %}
-
-
Warning
+
You a viewing the
latest unreleased documentation
v{{ version }}. You may prefer a
stable
version.
-
-
+
+
+
+
+
Warning
+ You a viewing the
latest unreleased documentation
+
v{{ version }}. You may prefer a
+
stable
+ version.
+
+
{%- endif %}
{{ super() }}
diff --git a/docs/src/conf.py b/docs/src/conf.py
index 08869beb18..b8cfb9f700 100644
--- a/docs/src/conf.py
+++ b/docs/src/conf.py
@@ -44,7 +44,7 @@ def autolog(message):
autolog("[READTHEDOCS] {} = {}".format(item, value))
# This is the rtd reference to the version, such as: latest, stable, v3.0.1 etc
-# TREMTEST: I may not need to create a variable, see https://docs.readthedocs.io/en/stable/development/design/theme-context.html?highlight=html_
+# For testing purposes this could be explicitly set to one of the above.
rtd_version = os.environ.get("READTHEDOCS_VERSION")
# -- Path setup --------------------------------------------------------------
@@ -300,7 +300,6 @@ def autolog(message):
"ignore_pattern": r"__init__\.py",
}
-
# -----------------------------------------------------------------------------
# Remove matplotlib agg warnings from generated doc when using plt.show
warnings.filterwarnings(
@@ -310,7 +309,6 @@ def autolog(message):
" non-GUI backend, so cannot show the figure.",
)
-
# -- numfig options (built-in) ------------------------------------------------
# Enable numfig.
numfig = True
From ea7459cbb79910191f0a936f88c0d6617528dc43 Mon Sep 17 00:00:00 2001
From: Tremain Knight <2108488+tkknight@users.noreply.github.com>
Date: Mon, 15 Feb 2021 11:20:43 +0000
Subject: [PATCH 16/21] updated comments
---
docs/src/_templates/layout.html | 1 -
docs/src/conf.py | 2 +-
2 files changed, 1 insertion(+), 2 deletions(-)
diff --git a/docs/src/_templates/layout.html b/docs/src/_templates/layout.html
index 352370375f..1a663383d0 100644
--- a/docs/src/_templates/layout.html
+++ b/docs/src/_templates/layout.html
@@ -7,7 +7,6 @@
/*---------------------------------------------------------------------------*/
{%- block document %}
-
{% if rtd_version == 'latest' %}
You a viewing the
latest unreleased documentation
diff --git a/docs/src/conf.py b/docs/src/conf.py
index b8cfb9f700..ab05312fca 100644
--- a/docs/src/conf.py
+++ b/docs/src/conf.py
@@ -44,7 +44,7 @@ def autolog(message):
autolog("[READTHEDOCS] {} = {}".format(item, value))
# This is the rtd reference to the version, such as: latest, stable, v3.0.1 etc
-# For testing purposes this could be explicitly set to one of the above.
+# For local testing purposes this could be explicitly set latest or stable.
rtd_version = os.environ.get("READTHEDOCS_VERSION")
# -- Path setup --------------------------------------------------------------
From 3bba3dc74fd4212235cf64749588e756adc3fcee Mon Sep 17 00:00:00 2001
From: Tremain Knight <2108488+tkknight@users.noreply.github.com>
Date: Tue, 16 Feb 2021 16:28:00 +0000
Subject: [PATCH 17/21] added whatsnew
---
docs/src/whatsnew/latest.rst | 3 +++
1 file changed, 3 insertions(+)
diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst
index a70385a7ed..c1d0ec58f7 100644
--- a/docs/src/whatsnew/latest.rst
+++ b/docs/src/whatsnew/latest.rst
@@ -91,6 +91,9 @@ This document explains the changes made to Iris for this release
#. `@bjlittle`_ added the |PyPI|_ badge to the `README.md`_. (:pull:`4004`)
+#. `@tkknight`_ added a banner at the top of every page if the unreleased
+ development documentatiion is being viewed. (:pull:`3999`)
+
💼 Internal
===========
From bef1febc5da0cc1a3fe048f869a381fddedfdab0 Mon Sep 17 00:00:00 2001
From: Tremain Knight <2108488+tkknight@users.noreply.github.com>
Date: Wed, 17 Feb 2021 09:43:49 +0000
Subject: [PATCH 18/21] expanded the if conditiion
---
docs/src/_templates/layout.html | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/src/_templates/layout.html b/docs/src/_templates/layout.html
index 1a663383d0..f9ce740753 100644
--- a/docs/src/_templates/layout.html
+++ b/docs/src/_templates/layout.html
@@ -7,7 +7,7 @@
/*---------------------------------------------------------------------------*/
{%- block document %}
- {% if rtd_version == 'latest' %}
+ {% if READTHEDOCS and rtd_version == 'latest' %}
You a viewing the
latest unreleased documentation
v{{ version }}. You may prefer a
From 9943d449f782384b134cdebce6c953cbadacbfeb Mon Sep 17 00:00:00 2001
From: Tremain Knight <2108488+tkknight@users.noreply.github.com>
Date: Wed, 17 Feb 2021 11:51:22 +0000
Subject: [PATCH 19/21] review actions
---
docs/src/_templates/layout.html | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/src/_templates/layout.html b/docs/src/_templates/layout.html
index f9ce740753..c60146b6d3 100644
--- a/docs/src/_templates/layout.html
+++ b/docs/src/_templates/layout.html
@@ -9,7 +9,7 @@
{%- block document %}
{% if READTHEDOCS and rtd_version == 'latest' %}
- You a viewing the
latest unreleased documentation
+ You are viewing the
latest unreleased documentation
v{{ version }}. You may prefer a
stable
version.
@@ -18,7 +18,7 @@
Warning
- You a viewing the
latest unreleased documentation
+ You are viewing the
latest unreleased documentation
v{{ version }}. You may prefer a
stable
version.
From 14d9b128da238b3837f0e112515fade849db5cb6 Mon Sep 17 00:00:00 2001
From: tkknight <2108488+tkknight@users.noreply.github.com>
Date: Fri, 19 Feb 2021 12:34:12 +0000
Subject: [PATCH 20/21] Update layout.html
Remove alternative banner that used the RestructuredText notation.
---
docs/src/_templates/layout.html | 9 ---------
1 file changed, 9 deletions(-)
diff --git a/docs/src/_templates/layout.html b/docs/src/_templates/layout.html
index c60146b6d3..96a2e0913e 100644
--- a/docs/src/_templates/layout.html
+++ b/docs/src/_templates/layout.html
@@ -15,15 +15,6 @@
version.
-
-
-
Warning
- You are viewing the
latest unreleased documentation
-
v{{ version }}. You may prefer a
-
stable
- version.
-
-
{%- endif %}
{{ super() }}
From be4a5863f5326a72da07188b29747e59bb4547f3 Mon Sep 17 00:00:00 2001
From: Tremain Knight <2108488+tkknight@users.noreply.github.com>
Date: Sat, 20 Feb 2021 10:49:24 +0000
Subject: [PATCH 21/21] review actions
---
docs/src/common_links.inc | 1 +
docs/src/whatsnew/latest.rst | 5 +++--
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/docs/src/common_links.inc b/docs/src/common_links.inc
index 3c465b67dc..23a933367e 100644
--- a/docs/src/common_links.inc
+++ b/docs/src/common_links.inc
@@ -24,6 +24,7 @@
.. _New Issue: https://github.com/scitools/iris/issues/new/choose
.. _pull request: https://github.com/SciTools/iris/pulls
.. _pull requests: https://github.com/SciTools/iris/pulls
+.. _Read the Docs: https://scitools-iris.readthedocs.io/en/latest/
.. _readthedocs.yml: https://github.com/SciTools/iris/blob/master/requirements/ci/readthedocs.yml
.. _SciTools: https://github.com/SciTools
.. _sphinx: https://www.sphinx-doc.org/en/master/
diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst
index c1d0ec58f7..538a38da9b 100644
--- a/docs/src/whatsnew/latest.rst
+++ b/docs/src/whatsnew/latest.rst
@@ -91,8 +91,9 @@ This document explains the changes made to Iris for this release
#. `@bjlittle`_ added the |PyPI|_ badge to the `README.md`_. (:pull:`4004`)
-#. `@tkknight`_ added a banner at the top of every page if the unreleased
- development documentatiion is being viewed. (:pull:`3999`)
+#. `@tkknight`_ added a banner at the top of every page of the unreleased
+ development documentation if being viewed on `Read the Docs`_.
+ (:pull:`3999`)
💼 Internal