added --all argument

.pre-commit-config.yaml

@@ -21,7 +21,4 @@ repos:
  entry: python scripts/generate_markdowns.py
  language: system
  types: [jupyter] 
-
-- repo: meta
- hooks:
- - id: identity 
+

Contributing.md

@@ -21,7 +21,7 @@ Here's what you need to do to add or edit tutorials 👇:
 2. If you're creating a new tutorial, follow the [naming convention](#naming-convention-for-file-names) for file names.
 3. Edit an existing tutorial or create a new one in the `/tutorials` folder by editing or creating `.ipynb` files.
 4. Pre-commit hooks will ensure the `markdowns` folder reflects your changes but you can update the docs at any time:
- - Run `python /scripts/generate_markdowns.py`. This generates or updates the relevant markdown file in `/markdowns`.
+ - Run `python /scripts/generate_markdowns.py --all`. This generates or updates the relevant markdown file in `/markdowns`.
 5. Create a pull request.
 6. Wait for the [CI](#ci-continuous-integration) checks to pass.
  These checks pass if the relevant markdown files are created.

scripts/generate_markdowns.py

@@ -3,6 +3,7 @@
 import re
 import argparse
 import sys
+import glob
 from pathlib import Path
 from typing import Sequence
 
@@ -156,9 +157,7 @@
 }
 
 notebook_tutorials_dir = Path(__file__).parent.parent / "tutorials"
-print(notebook_tutorials_dir)
 markdown_tutorials_dir = Path(__file__).parent.parent / "markdowns"
-print(markdown_tutorials_dir)
 
 md_exporter = MarkdownExporter(exclude_output=True)
 
@@ -183,16 +182,22 @@ def generate_markdown_from_notebook(nb_path: str):
 
 
 def main(argv: Sequence[str] = sys.argv):
- print("here I am!")
  parser = argparse.ArgumentParser()
- parser.add_argument("filenames", nargs="*", help="Filenames to check.")
+ parser.add_argument("filenames", nargs="*", help="Notebooks filenames")
+ parser.add_argument(
+ "--all",
+ action="store_true",
+ help="Generate markdown version for all the notebooks",
+ )
  args = parser.parse_args(argv)
- print(args)
 
- for filename in args.filenames:
+ filenames = args.filenames
+ if args.all:
+ filenames = glob.glob(f"{notebook_tutorials_dir}/*.ipynb")
+
+ for filename in filenames:
  filepath = Path(filename)
  if filepath.parent == notebook_tutorials_dir and filepath.suffix == ".ipynb":
- print(filepath)
  generate_markdown_from_notebook(str(filepath))
 
  return 0