From 44bab2341d97707365396efc0b23a1edac26da7c Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Wed, 27 Apr 2022 15:05:20 +0200 Subject: [PATCH] DOCS: Add recommendation for sphinx-design (#79) --- .pre-commit-config.yaml | 4 ++-- README.md | 2 ++ docs/index.rst | 6 ++++++ setup.py | 2 ++ 4 files changed, 12 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4ebc973..4bc95b9 100644 --- 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 index b5c907b..232701f 100644 --- 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 index 70b63bc..2fe55aa 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,6 +4,12 @@ sphinx-panels ============= +.. warning:: + + This repository is not actively maintained. + Use `sphinx-design `_ instead! + See `the migration guide `_ and `this github issue `_ 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 index 1dc86c2..350df47 100644 --- 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",