search

executablebooks / sphinx-panels

A sphinx extension for creating panels in a grid layout
https://sphinx-panels.readthedocs.io
MIT License
83 stars 20 forks source link

DOCS: Add recommendation for sphinx-design #79

Closed choldgraf closed 2 years ago

choldgraf commented 2 years ago

This clarifies that this repository is no longer actively maintained, and suggests that people use sphinx-design instead. This should help steer newcomers to this package to sphinx-design so that they use a more up-to-date tool.

chrisjsewell commented 2 years ago

Cheers. I guess need to get RTD passing, otherwise it won't update the website. Also maybe link directly to https://sphinx-design.readthedocs.io/en/latest/get_started.html#migrating-from-sphinx-panels

choldgraf commented 2 years ago

Ah yeah the RTD error was https://github.com/sphinx-doc/sphinx/issues/10291

Good call on the migration guide - will link to that in that Jupyter Book PR as well

chrisjsewell commented 2 years ago

Note there is also some extra notes in https://github.com/executablebooks/sphinx-design/issues/51

choldgraf commented 2 years ago

Hmm - I'm not sure what to do about the web-compile pre-commit hook being broken, I think that's the same Jinja2 error but not sure how to pin Jinja inside of a pre-commit hook.

chrisjsewell commented 2 years ago

I wouldn't worry about the pre-commit