-
Notifications
You must be signed in to change notification settings - Fork 208
readme: adding quickstart section #1291
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! Looks good.
Nit, we dont have a lint but would you mind making lines < 88 characters (I think we use the default 88)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! Some nits.
Co-authored-by: Lucy Liu <jliu176@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The failing package build
https://github.com/sphinx-gallery/sphinx-gallery/actions/runs/8763137531/job/24051683552?pr=1291
seems related but I'm not sure what syntax error it's talking about. Maybe it doesn't like the .. warning::
and/or .. note::
in the description?
Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
@larsoner, it turned out that the problem was space at the beginning of continuation lines... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Python 3.12/sphinx dev CI failures seem unrelated, I'll have to investigate.
Co-authored-by: Lucy Liu <jliu176@gmail.com>
@lucyleeow, is there anything left I can do? 🐿️ |
Sorry, yes this can go in, docs building fine (warning unrelated) |
Adding quicks start section to demonstrate the simplicity of this extension
reaction to #1288 (comment)
cc: @lucyleeow