Lint extension: verify the appreance of data and figures in a notebook

jckantor / nbpages

Command line tool to maintain a repository of Jupyter notebooks.

https://jckantor.github.io/nbpages/

MIT License

3 stars 4 forks source link

Lint extension: verify the appreance of data and figures in a notebook #30

Closed adowling2 closed 4 years ago

adowling2 commented 4 years ago

This helps find "orphaned" data and figures. It is also a precursor to data and figure TOC.

jckantor commented 4 years ago

Here's how this might work ...

complete section numbering
reads a list of files appearing in data_dir
for each file name, search over all cells in all sections in all notebooks to create an index with the section number and link to section where the string appears. The section is the most specific level link available.
sort data file index by section and by file name, then report by filename.
repeat for figures.

Report

data file index
figure file index
add list of data to table of contents for each notebook.

adowling2 commented 4 years ago

I like it! Your approach makes sense.

jckantor commented 4 years ago

This has been implemented for figures. The result is a Figure Index that appears in the index.md home page. It's been incredibly useful for finding and managing figures, and also enabled selective copying of figures for --publish. Need to finish this with an implementation for data files.

jckantor commented 4 years ago

This is now done for both figures and data files. Only files actually appearing in the notebooks get copied to docs. Lint reports unused files. The index page provides links to a data and figure index, if they are non-nil.