8000 readme: adding quickstart section by Borda · Pull Request #1291 · sphinx-gallery/sphinx-gallery · GitHub
[go: up one dir, main page]

Skip to content

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

Merged
merged 14 commits into from
Apr 22, 2024
Merged

Conversation

Borda
Copy link
Contributor
@Borda Borda commented Apr 19, 2024

Adding quicks start section to demonstrate the simplicity of this extension

reaction to #1288 (comment)

cc: @lucyleeow

Copy link
Contributor
@lucyleeow lucyleeow left a 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)

@Borda Borda requested a review from lucyleeow April 19, 2024 12:32
@Borda Borda requested a review from larsoner April 19, 2024 13:41
Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
Copy link
Contributor
@lucyleeow lucyleeow left a 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>
Copy link
Contributor
@larsoner larsoner left a 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?

Borda and others added 2 commits April 21, 2024 08:58
Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
@Borda
Copy link
Contributor Author
Borda commented Apr 21, 2024

The failing package build

@larsoner, it turned out that the problem was space at the beginning of continuation lines...

@Borda Borda requested a review from larsoner April 21, 2024 09:08
Copy link
Contributor
@lucyleeow lucyleeow left a 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>
@Borda
Copy link
Contributor Author
Borda commented Apr 22, 2024

@lucyleeow, is there anything left I can do? 🐿️

@lucyleeow
Copy link
Contributor

Sorry, yes this can go in, docs building fine (warning unrelated)

@lucyleeow lucyleeow merged commit 0790260 into sphinx-gallery:master Apr 22, 2024
@Borda Borda deleted the quickstart branch April 22, 2024 09:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0