Eric Larson
Eric Larson
> Initially, I wanted to just load SG as extension, but this didn't work without a valid 'examples_dirs'. We can relax this / make it not raise an error >...
Could you take a page like this, that is essentially for you the "overview gallery": https://mne.tools/dev/auto_tutorials/index.html Which gets generated from: https://github.com/mne-tools/mne-python/blob/master/tutorials/README.txt And add to the top a list of RST...
It's not officially supported AFAIK but you could `import sphinx_gallery.gen_rst` then monkey-patch this attribute in your `conf.py`. It should then take effect in your builds
> the Circle failure is quite odd Sphinx does not give the nicest tracebacks. Have you tried `make html` in the `doc` dir of sphinx-gallery, then looking at the logs?...
From a quick look, code looks reasonable! But CIs are unhappy. Let me know when things are green or you need help interpreting To demo this functionality, could you open...
You could try `:py:obj:`, it might resolve to either of those
I only think functions that are *documented* (regardless of whether or not they're public), ie., end up on an API page, should be accounted for. Hence my suggestion to hook...
numpydoc hooks into the autodoc process, look there and you should find it
Does even `env-updated` happen before `autodoc` events? https://www.sphinx-doc.org/en/master/extdev/appapi.html#event-env-updated If it happens after all `autodoc` events, then it seems like this could be used to add your new RST file paths
Not that I know of currently. We could add a config arg `title_format='rst' | 'pep257'`, the former (default) what we do now and the latter taking whatever the first line...