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.

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

Set up sphinx-gallery #92

Merged
merged 2 commits into from
Oct 18, 2023
Merged

Set up sphinx-gallery #92

merged 2 commits into from
Oct 18, 2023

Conversation

WardBrian
Copy link
Collaborator

Closes #57
A few notes:

  • @eickenberg I think it would be good to write a brief introduction to what the goal of the 2d convolution example is, and maybe a summary/conclusion after the final code block.
  • Sphinx-gallery produces .ipynb files, which causes nbsphinx to complain about there being two sets of source files for the final page. As a result, I had to disable nbsphinx, and it seems like we'll want an either-or approach here.
  • Building the docs fully does now require the full dependency chain to be installed. You can run make fast-* (e.g. make fast-html) to build the docs without running the gallery examples.

@WardBrian WardBrian requested a review from eickenberg October 18, 2023 18:08
Copy link
Collaborator

@eickenberg eickenberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@eickenberg
Copy link
Collaborator

I will improve the example, but this can be merged in the meantime

@eickenberg eickenberg merged commit 2f23868 into main Oct 18, 2023
@WardBrian WardBrian deleted the docs/sphinx-gallery branch October 25, 2023 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ENH examples
2 participants