Skip to content

Commit

Permalink
Document using nbstripout on all files in the current directory and s…
Browse files Browse the repository at this point in the history
…ubdirectories recursively

This was requested in #127.
  • Loading branch information
kynan committed Jul 2, 2024
1 parent 5077ab4 commit c6c1067
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,25 @@ or

nbstripout -t FILE.ipynb | other-command

Do a dry run and only list which files would have been stripped:

nbstripout --dry-run FILE.ipynb [FILE2.ipynb ...]

Operate on all `.ipynb` files in the current directory and subdirectories
recursively:

find . -name '*.ipynb' -exec nbstripout {} +

Print the version:

nbstripout --version

Show help and usage instructions:

nbstripout --help

### Using as a Git filter

Set up the git filter and attributes as described in the manual installation
instructions below:

Expand Down Expand Up @@ -132,18 +151,6 @@ if installed, 1 otherwise):

nbstripout --status

Do a dry run and only list which files would have been stripped:

nbstripout --dry-run FILE.ipynb [FILE2.ipynb ...]

Print the version:

nbstripout --version

Show help and usage instructions:

nbstripout --help

### Configuration files

The following table shows in which files the `nbstripout` filter and attribute
Expand Down

0 comments on commit c6c1067

Please sign in to comment.