From 2c94715f2af43024858cc74e86a0d39407e807aa Mon Sep 17 00:00:00 2001 From: trhallam <8454087+trhallam@users.noreply.github.com> Date: Tue, 21 May 2024 11:01:28 +0100 Subject: [PATCH] add prolog banner to depreciate docs --- docs/conf.py | 11 +++++------ setup.cfg | 1 - 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index b4b1962..a34ff92 100644 --- 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 index 56b594c..12e7d37 100644 --- a/setup.cfg +++ b/setup.cfg @@ -64,7 +64,6 @@ docs = jupyterlab wellpathpy pyshp - sphinx-version-warning [options.entry_points] console_scripts =