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

Jump to bottom

DOCS: Add recommendation for sphinx-design #79

Merged

choldgraf merged 7 commits into master from docs-redirect

Apr 27, 2022

Member

choldgraf commented Apr 23, 2022

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.


          DOCS: Add recommendation for sphinx-design

cb3c869

Member

chrisjsewell commented Apr 23, 2022

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


          Warnings and pin Sphinx

a53071b

choldgraf commented

View reviewed changes

setup.py Outdated Show resolved Hide resolved


          Update setup.py

063387a

choldgraf commented

View reviewed changes

setup.py Outdated Show resolved Hide resolved


          Update setup.py

7c26c83

Member Author

choldgraf commented Apr 23, 2022

Ah yeah the RTD error was sphinx-doc/sphinx#10291

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


          pre-commit

b370853

Member

chrisjsewell commented Apr 23, 2022 •

edited

Loading

Note there is also some extra notes in executablebooks/sphinx-design#51

choldgraf commented

View reviewed changes

.pre-commit-config.yaml Outdated Show resolved Hide resolved


          Update .pre-commit-config.yaml

6cc04bc

Member Author

choldgraf commented Apr 23, 2022

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.

Member

chrisjsewell commented Apr 23, 2022

I wouldn't worry about the pre-commit

choldgraf commented

View reviewed changes

README.md Outdated Show resolved Hide resolved

choldgraf commented

View reviewed changes

docs/index.rst Outdated Show resolved Hide resolved


          Apply suggestions from code review

42556ef

chrisjsewell approved these changes

View reviewed changes

choldgraf merged commit 44bab23 into master

choldgraf deleted the docs-redirect branch

April 27, 2022 13:05

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet