DOCS: Add recommendation for sphinx-design (#79)

executablebooks · Apr 27, 2022 · 44bab23 · 44bab23
1 parent 4a310eb
commit 44bab23
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -28,12 +28,12 @@ repos:
     - id: check-manifest
 
   - repo: https://github.com/psf/black
-    rev: 20.8b1
+    rev: "22.3.0"
     hooks:
     - id: black
 
   - repo: https://github.com/executablebooks/web-compile
-    rev: v0.2.0
+    rev: v0.2.2
     hooks:
       - id: web-compile
         files: >-

diff --git a/README.md b/README.md
@@ -4,6 +4,8 @@
 [![Code style: black][black-badge]][black-link]
 [![PyPI][pypi-badge]][pypi-link]
 
+🚨This repository is not actively maintained. Use [`sphinx-design`](https://github.com/executablebooks/sphinx-design) instead! See [the migration guide](https://sphinx-design.readthedocs.io/en/latest/get_started.html#migrating-from-sphinx-panels) and [this github issue](https://github.com/executablebooks/sphinx-design/issues/51) for more information.🚨
+
 A sphinx extension for creating document components optimised for HTML+CSS.
 
 - The `panels` directive creates panels of content in a grid layout, utilising both the Bootstrap 4 [grid system](https://getbootstrap.com/docs/4.0/layout/grid/), and [cards layout](https://getbootstrap.com/docs/4.0/components/card/).

diff --git a/docs/index.rst b/docs/index.rst
@@ -4,6 +4,12 @@
 sphinx-panels
 =============
 
+.. warning::
+
+   This repository is not actively maintained.
+   Use `sphinx-design <https://github.com/executablebooks/sphinx-design>`_ instead!
+   See `the migration guide <https://sphinx-design.readthedocs.io/en/latest/get_started.html#migrating-from-sphinx-panels>`_ and `this github issue <https://github.com/executablebooks/sphinx-design/issues/51>`_ for more information.
+
 A sphinx extension for creating panels in a grid layout or as drop-downs.
 
 - The ``panels`` directive creates panels of content in a grid layout, utilising both the bootstrap 4

diff --git a/setup.py b/setup.py
@@ -31,6 +31,8 @@
     ],
     extras_require={
         "themes": [
+            # ref: https://github.com/sphinx-doc/sphinx/issues/10291
+            "Jinja2<3.1",
             "sphinx-rtd-theme",
             "pydata-sphinx-theme~=0.4.0",
             "sphinx-book-theme~=0.0.36",