Possible to ignore a file with sphinx-gallery?

I’m trying to get SG set up with a project that needs an __init__.py file inside of the examples folder. This is giving sphinx-gallery issues because if there’s no docstring it will error, and if I add a docstring then I get an empty image in the gallery for the init file. Is there a way to tell SG to totally ignore a file (e.g., with a regex or something?)

[lesteve]

I am in favour of allowing to ignore completely a file based on a regex (based on re.search applied to the full absolute path). It does not seem too hard to do, I am guessing we can just skip files when we walk the examples folders. I may even be in favour of skipping __init__.py files by default.

[lesteve]

@nicain if you just want to run the examples in the CI, you just need to do something like:

python setup.py install
cd doc
make html

You will get a non-zero exit code if at least one of the example does not run so your CI will fail. Look at https://github.com/sphinx-gallery/sphinx-gallery/blob/master/.travis.yml for how we do it in sphinx-gallery. This is how examples are tested in all the sphinx-gallery usages I know of, scikit-learn, mne-python, matplotlib, etc …

FWIW, I found out the reason that the initial package includes init.py in their examples folder. It’s because they want users to be able to do from mypackage.examples import plot_example; plot_example()

@choldgraf it would make sense to have an additional variable to completely exclude files from the gallery. I would not say this is very high priority though. I don’t see a good reason what you gain from having the examples inside the package. In particular it feels like from mypackage.examples.some_example import plot_example; plot_example() is kind of the same as ipython mypackage/examples/some_example.py. Do you have a link for the project you are mentioning out of curiosity?