add prolog banner to depreciate docs

trhallam · May 21, 2024 · 2c94715 · 2c94715
1 parent dd41929
commit 2c94715
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 7 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -53,6 +53,11 @@
 release = release
 today_fmt = "%d %B %Y"
 
+rst_prolog = """.. attention::
+    From version v0.5, SEGY-SAK has migrated the documentation to https://trhallam.github.io/segysak/latest/.
+
+    This documentation will be archived from v0.6.
+"""
 
 # -- General configuration ---------------------------------------------------
 
@@ -69,7 +74,6 @@
     "sphinx.ext.mathjax",
     "nbsphinx",
     "sphinx_copybutton",
-    "versionwarning.extension",
 ]
 
 autosummary_generate = True
@@ -189,8 +193,3 @@ def setup(app):
     "http://xarray.pydata.org/en/stable/": None,
     "https://pandas.pydata.org/docs/": None,
 }
-
-versionwarning_default_message = "from v0.5, the documentation for SEGY-SAK has migrated to `Gh-pages https://trhallam.github.io/segysak/latest/`_ ."
-versionwarning_messages = {
-    "latest": "from v0.5, the documentation for SEGY-SAK has migrated to `Gh-pages https://trhallam.github.io/segysak/latest/`_ .",
-}
diff --git a/setup.cfg b/setup.cfg
@@ -64,7 +64,6 @@ docs =
     jupyterlab
     wellpathpy
     pyshp
-    sphinx-version-warning
 
 [options.entry_points]
 console_scripts =