Skip to content

Commit 44bab23

Browse files
authored
DOCS: Add recommendation for sphinx-design (#79)
1 parent 4a310eb commit 44bab23

4 files changed

Lines changed: 12 additions & 2 deletions

File tree

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ repos:
2828
- id: check-manifest
2929

3030
- repo: https://github.com/psf/black
31-
rev: 20.8b1
31+
rev: "22.3.0"
3232
hooks:
3333
- id: black
3434

3535
- repo: https://github.com/executablebooks/web-compile
36-
rev: v0.2.0
36+
rev: v0.2.2
3737
hooks:
3838
- id: web-compile
3939
files: >-

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
[![Code style: black][black-badge]][black-link]
55
[![PyPI][pypi-badge]][pypi-link]
66

7+
🚨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.🚨
8+
79
A sphinx extension for creating document components optimised for HTML+CSS.
810

911
- 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/).

docs/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
sphinx-panels
55
=============
66

7+
.. warning::
8+
9+
This repository is not actively maintained.
10+
Use `sphinx-design <https://github.com/executablebooks/sphinx-design>`_ instead!
11+
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.
12+
713
A sphinx extension for creating panels in a grid layout or as drop-downs.
814

915
- The ``panels`` directive creates panels of content in a grid layout, utilising both the bootstrap 4

setup.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
],
3232
extras_require={
3333
"themes": [
34+
# ref: https://github.com/sphinx-doc/sphinx/issues/10291
35+
"Jinja2<3.1",
3436
"sphinx-rtd-theme",
3537
"pydata-sphinx-theme~=0.4.0",
3638
"sphinx-book-theme~=0.0.36",

0 commit comments

Comments
 (0)