Skip to content
This repository was archived by the owner on Apr 3, 2026. It is now read-only.

Commit c1b8e3b

Browse files
committed
docs: add banner to point to new docs domain
1 parent e32dcb3 commit c1b8e3b

File tree

3 files changed

+17
-9
lines changed

3 files changed

+17
-9
lines changed

.readthedocs.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
# Required
66
version: 2
77

8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.11"
12+
813
# Build documentation in the docs/ directory with Sphinx
914
sphinx:
1015
configuration: docs/source/conf.py
@@ -18,6 +23,5 @@ formats: all
1823

1924
# Optionally set the version of Python and requirements required to build your docs
2025
python:
21-
version: 3.7
2226
install:
2327
- requirements: docs/source/requirements.txt

docs/source/conf.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@
1010
# import sys
1111
# sys.path.insert(0, os.path.abspath('.'))
1212

13+
html_theme_options = {
14+
# Announcement banner defined as a string of arbitrary HTML, temporarily
15+
# displayed at the top of each page until the user begins scrolling.
16+
'announcement': '⚠️ This documentation has moved. See: <a style="color: blue" href="https://docs.mapswipe.org/">https://docs.mapswipe.org</a>',
17+
}
1318

1419
# -- Project information -----------------------------------------------------
1520

@@ -27,7 +32,7 @@
2732
"sphinx.ext.autodoc",
2833
"sphinx.ext.napoleon",
2934
"sphinx_markdown_tables",
30-
"m2r",
35+
"m2r2",
3136
]
3237

3338
# Add any paths that contain templates here, relative to this directory.
@@ -55,7 +60,7 @@
5560
# The theme to use for HTML and HTML Help pages. See the documentation for
5661
# a list of builtin themes.
5762
#
58-
html_theme = "sphinx_rtd_theme"
63+
html_theme = "sphinx_book_theme"
5964

6065
# Add any paths that contain custom static files (such as style sheets) here,
6166
# relative to this directory. They are copied after the builtin static files,

docs/source/requirements.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
Sphinx==2.1.2
2-
recommonmark==0.5.0
3-
sphinx-markdown-tables==0.0.9
4-
sphinx-rtd-theme==0.4.3
5-
mistune==0.8.4
6-
m2r==0.2.1
1+
recommonmark
2+
sphinx-markdown-tables
3+
sphinx-book-theme
4+
# mistune
5+
m2r2

0 commit comments

Comments
 (0)