sphinx maintenance (pymc-devs#255)

martiningram · Dec 15, 2021 · 212a201 · 212a201
1 parent f0b04ff
commit 212a201
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 1 deletion.
diff --git a/examples/404.md b/examples/404.md
@@ -0,0 +1,44 @@
+---
+orphan: true
+---
+
+# Page not found
+
+**Sorry, we could not find this page**
+
+We are working on the next major release for PyMC,
+which will come with faster sampling, more flexible
+model building, multiple computational backends...
+
+::::{grid} 3
+:::{grid-item}
+![old banner](https://raw.githubusercontent.com/pymc-devs/pymc/v3/docs/logos/svg/PyMC3_banner.svg)
+:::
+:::{grid-item}
+:class: text-center
+{fas}`arrow-alt-circle-right;fa-5x`
+:::
+:::{grid-item}
+![new banner](https://raw.githubusercontent.com/pymc-devs/pymc/main/docs/logos/svg/PyMC_banner.svg)
+:::
+::::
+
+...and much better documentation too! However, to
+do so we have moved some files around and we have
+modified the base url in order to support multi version docs
+and better rendering and cross-referencing for notebooks.
+
+::::{grid} 3
+:::{grid-item}
+:::
+:::{grid-item}
+```{button-link} https://docs.pymc.io/projects/examples/en/latest/
+:color: primary
+:expand:
+
+Back to example gallery homepage
+```
+:::
+:::{grid-item}
+:::
+::::
diff --git a/examples/conf.py b/examples/conf.py
@@ -19,7 +19,8 @@
     "sphinxext.opengraph",
     "sphinx_copybutton",
     "sphinxcontrib.bibtex",
-    # "sphinx_codeautolink",
+    "sphinx_codeautolink",
+    "notfound.extension",
 ]
 
 # List of patterns, relative to source directory, that match files and

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -7,3 +7,4 @@ sphinxcontrib-bibtex
 ablog
 sphinxext-opengraph
 sphinx-codeautolink
+sphinx-notfound-page