Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: Add recommendation for sphinx-design #79

Merged
merged 7 commits into from
Apr 27, 2022
Merged

DOCS: Add recommendation for sphinx-design #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cb3c869
DOCS: Add recommendation for sphinx-design
choldgraf Apr 23, 2022
a53071b
Warnings and pin Sphinx
choldgraf Apr 23, 2022
063387a
Update setup.py
choldgraf Apr 23, 2022
7c26c83
Update setup.py
choldgraf Apr 23, 2022
b370853
pre-commit
choldgraf Apr 23, 2022
6cc04bc
Update .pre-commit-config.yaml
choldgraf Apr 23, 2022
42556ef
Apply suggestions from code review
choldgraf Apr 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: >-
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down
6 changes: 6 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down