mkdocs-gallery icon indicating copy to clipboard operation
mkdocs-gallery copied to clipboard

Support for sphinx-gallery's copyfile_regex configuration option

Open rprechelt opened this issue 1 year ago • 2 comments

It's a semi-common use case that the source scripts/notebooks used in sphinx-gallery have some static data files that they depend on (e.g. .csv files they load and process as part of the example). sphinx-gallery has the copyfile_regex config so that the these files can be copied from the source to the generated directory and included in the downloadable .zip files.

As far as I know, mkdocs-gallery does not support this functionality. This would be great as otherwise there is, AFAIK, no path for moving from sphinx-gallery if you have any static resources that need to packaged along with your scripts.

rprechelt avatar Dec 19 '24 02:12 rprechelt

Hi, I just stumbled across exactly the same issue. Are there any plans to support copyfile_regex in mkdocs-gallery?

Thanks in advance!

nilskre avatar Apr 01 '25 13:04 nilskre

Hi there ! I can certainly review any such PR if you would like to propose one. Note that this is maybe relatively easy : I tried my best to keep the code base identical to sphinx-gallery when I copied their source over. I only adapted the mkdocs aspects. but preserved most of the structure, function names, mechanisms etc.

So it is probably just a matter of making a diff between the two code bases, specifically in the places where this option is mentioned.

smarie avatar May 09 '25 20:05 smarie