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

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

Closed
adowling2 opened this issue May 28, 2020 · 4 comments
Closed
Labels
enhancement New feature or request need to discuss Still need to discuss

Comments

@adowling2
Copy link
Collaborator

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

@adowling2 adowling2 added the enhancement New feature or request label May 28, 2020
@adowling2 adowling2 added this to the Fall 2020 Session milestone May 28, 2020
@jckantor
Copy link
Owner

jckantor commented May 29, 2020

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.

@jckantor jckantor added the need to discuss Still need to discuss label May 30, 2020
@adowling2
Copy link
Collaborator Author

I like it! Your approach makes sense.

@jckantor
Copy link
Owner

jckantor commented Jun 1, 2020

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
Copy link
Owner

jckantor commented Jun 1, 2020

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.

@jckantor jckantor closed this as completed Jun 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request need to discuss Still need to discuss
Projects
None yet
Development

No branches or pull requests

2 participants