Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Generate beautiful, testable documentation with Jupyter Notebooks
pip install nbdoc
This library consists of two cli tools as noted below.
! nbdoc_build --help
usage: nbdoc_build [-h] [--srcdir SRCDIR] [--force_all FORCE_ALL]
[--n_workers N_WORKERS] [--pause PAUSE]
Build the documentation by converting notebooks in `srcdir` to markdown
optional arguments:
-h, --help show this help message and exit
--srcdir SRCDIR A directory of notebooks to convert to docs
recursively, can also be a filename.
--force_all FORCE_ALL Rebuild even notebooks that havent changed (default:
False)
--n_workers N_WORKERS Number of workers to use
--pause PAUSE Pause time (in secs) between notebooks to avoid race
conditions (default: 0.5)
! nbdoc_update -h
usage: nbdoc_update [-h] [--srcdir SRCDIR] [--flags FLAGS]
[--n_workers N_WORKERS] [--pause PAUSE]
Refresh all notebooks in `srcdir` by running them and saving them in place.
optional arguments:
-h, --help show this help message and exit
--srcdir SRCDIR A directory of notebooks to refresh recursively, can
also be a filename.
--flags FLAGS Space separated list of flags (tst_flags in
settings.ini) to NOT ignore while running notebooks.
Otherwise, those cells are ignored.
--n_workers N_WORKERS Number of workers to use
--pause PAUSE Pause time (in secs) between notebooks to avoid race
conditions (default: 0.5)
nbdoc_test
is just an alias of nbdev_test_nbs
from nbdev, and is a lightweight way to test notebooks.
! nbdoc_test --help
usage: nbdoc_test [-h] [--fname FNAME] [--flags FLAGS] [--n_workers N_WORKERS]
[--verbose VERBOSE] [--timing] [--pause PAUSE]
Test in parallel the notebooks matching `fname`, passing along `flags`
optional arguments:
-h, --help show this help message and exit
--fname FNAME A notebook name or glob to convert
--flags FLAGS Space separated list of flags
--n_workers N_WORKERS Number of workers to use
--verbose VERBOSE Print errors along the way (default: True)
--timing Timing each notebook to see the ones are slow (default:
False)
--pause PAUSE Pause time (in secs) between notebooks to avoid race
conditions (default: 0.5)
! nbdoc_linkify --help
usage: nbdoc_linkify [-h] [--local] [--md_path MD_PATH]
Convert names in `backticks` in markdown files that have been documented with
nbdoc.showdoc.ShowDoc to appropriate links.
optional arguments:
-h, --help show this help message and exit
--local Whether or not to build an index based on local documents
(default: True)
--md_path MD_PATH Root path to search recursively containing markdown files
to linkify
Documentation can be found here.
nbdoc is built with nbdev. Furthermore, much of the code in this project is re-purposed from nbdev directly.
FAQs
Generate beautiful, testable documentation with Jupyter Notebooks
We found that nbdoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.