<jupyter_start><jupyter_text>gen_doc.gen_notebooks This module contains the scripts to auto-generate or update the notebooks from a given .py file or a full package. To use in a script and not a library, use sgen_notebooks. **Important notes:**  - In all the functions below, the functions and classes considered in a notebook are defined by the attribute \_\_all\_\_. - It is assumed the destination folder   1. has the file nbdoc.py to get the doc functions   2. has a simlink to the package you want to document if that package isn't installed<jupyter_code>from nbdoc import * 
get_module_toc("gen_doc.gen_notebooks")
show_doc_from_name('gen_doc.gen_notebooks','create_module_page', 
                   arg_comments={'mod_name': 'the name of the module',
                                 'dest_path': 'the folder in which to generate the notebook'})
show_doc(gen_doc.gen_notebooks.create_module_page)<jupyter_output><empty_output><jupyter_text>**create_module_page**(mod_name:str, dest_path:str=None)*Creates the documentation notebook for module `mod_name` in path `dest_path`*<jupyter_code>show_doc_from_name('gen_doc.gen_notebooks','generate_all',
                   arg_comments={'pkg_name': 'name of the package to document',
                                 'dest_path': 'the folder in which to generate the notebooks',
                                 'exclude': 'names of subdirectories to ignore'})
show_doc_from_name('gen_doc.gen_notebooks','update_all',
                   arg_comments={'mod_name': 'name of the package to document',
                                 'dest_path': 'the folder in which to generate the notebooks',
                                 'exclude': 'names of subdirectories to ignore'})<jupyter_output><empty_output><jupyter_text>**Important note:** During an update, all the cells added by a user are conserved, only the cells of new functions (aka that weren't documented before) will be inserted.<jupyter_code>show_doc_from_name('gen_doc.gen_notebooks','update_module_page',
                   arg_comments={'mod_name': 'the name of the module',
                                 'dest_path': 'the folder in which to generate the notebook'})<jupyter_output><empty_output>
{'fraction_non_alphanumeric': 0.08593396653098145, 'fraction_numerical': 0.0009045680687471732, 'mean_word_length': 3.345776031434185, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'chain_length': '3', 'dir': 'jupyter-structured-clean-dedup', 'id': '547672', 'license': 'Apache-2.0', 'n_tokens_mistral': 624, 'n_tokens_neox': 614, 'n_words': 202, 'path': 'docs/example/gen_doc.gen_notebooks.ipynb', 'repo_name': 'gurvindersingh/fastai_v1', 'size': '2211'}