From 6e742800c1edd247906fa2400de89462b514e9cd Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 9 Nov 2022 19:09:16 +0100 Subject: [PATCH 1/3] Remove instructions "encouraging" to install directly from git --- docs/installing.rst | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/docs/installing.rst b/docs/installing.rst index d9a5d00f9..87c0c6678 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -58,21 +58,3 @@ Otherwise, pip will ignore pre-releases. Add for instance ``sphinx-rtd-theme==1. More information is available in Read the Docs' documentation on :doc:`rtd:guides/reproducible-builds`. - -Via Git or Download -------------------- - -.. warning:: - - Installing directly from the repository source is deprecated and is not - recommended. Static assets won't be included in the repository starting in - release :ref:`roadmap-release-3.0.0`. - -Symlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into your documentation at -``docs/_themes/sphinx_rtd_theme`` then add the following two settings to your Sphinx -``conf.py`` file: - -.. code:: python - - html_theme = "sphinx_rtd_theme" - html_theme_path = ["_themes", ] From 4ff83ea4b72af6d34766a3d41a755d3398333e71 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 9 Nov 2022 19:11:37 +0100 Subject: [PATCH 2/3] Update changelog: Add reminder that people should not install directly from git --- docs/changelog.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index fd6302b51..e279f3775 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -4,10 +4,15 @@ Changelog .. seealso:: :ref:`howto_upgrade` +.. |development_version| replace:: 1.1.2alpha1 + Development version (|development_version|) =========================================== -.. |development_version| replace:: 1.1.2alpha1 +Deprecated +---------- + +* A reminder to not install the theme directly from Git, we will remove support for this in 3.0 .. _release-1.1.1: From ce56233bead05bc4710b6b622c8d70249e40e23b Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Mon, 14 Nov 2022 17:22:18 +0100 Subject: [PATCH 3/3] Update docs/changelog.rst --- docs/changelog.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index e279f3775..1c61be58c 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -12,7 +12,7 @@ Development version (|development_version|) Deprecated ---------- -* A reminder to not install the theme directly from Git, we will remove support for this in 3.0 +* Reminder: In 3.0, we will remove support for installing this theme directly from its git repository. Instead, please use releases from PyPi. .. _release-1.1.1: