docs: add banner to point to new docs domain

Author: thenav56

.readthedocs.yml

@@ -5,6 +5,11 @@
 # Required
 version: 2
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/source/conf.py
@@ -18,6 +23,5 @@ formats: all
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
   install:
     - requirements: docs/source/requirements.txt

docs/source/conf.py

@@ -10,6 +10,16 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+html_theme_options = {
+    # Announcement banner defined as a string of arbitrary HTML, temporarily
+    # displayed at the top of each page until the user begins scrolling.
+    'announcement': """
+       <div style="background-color: #fff3cd; padding: 12px; border-left: 5px solid #ffa502; margin-bottom: 20px;">
+         ⚠️ This documentation has moved to <a href="https://docs.mapswipe.org/">https://docs.mapswipe.org</a>.
+         Please update your bookmarks.
+       </div>
+    """,
+}
 
 # -- Project information -----------------------------------------------------
 
@@ -27,7 +37,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx_markdown_tables",
-    "m2r",
+    "m2r2",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -55,7 +65,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_book_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/source/requirements.txt

@@ -1,6 +1,5 @@
-Sphinx==2.1.2
-recommonmark==0.5.0
-sphinx-markdown-tables==0.0.9
-sphinx-rtd-theme==0.4.3
-mistune==0.8.4
-m2r==0.2.1
+recommonmark
+sphinx-markdown-tables
+sphinx-book-theme
+# mistune
+m2r2