shortcuts

Shortcuts for common operations you need to perform with nbdev

Installation


install

 install ()

Install Quarto and the current library


install_quarto

 install_quarto ()

Install latest Quarto on macOS or Linux, prints instructions for Windows

Docs

Generate Docs


docs

 docs (path:str=None, doc_path:str=None, symlinks:bool=False,
       folder_re:str=None, skip_file_glob:str=None, skip_file_re:str=None,
       preview:bool=False)

Generate docs

Type Default Details
path str None Path to notebooks
doc_path str None Path to output docs
symlinks bool False Follow symlinks?
folder_re str None Only enter folders matching regex
skip_file_glob str None Skip files matching glob
skip_file_re str None Skip files matching regex
preview bool False Preview the site instead of building it

Preview Docs


preview

 preview ()

Start a local docs webserver

Deploy Docs


deploy

 deploy ()

Deploy docs to GitHub Pages

Publish Packages


release

 release ()

Release both conda and PyPI packages


conda

 conda (ver_bump=True)

Create and upload a conda package


pypi

 pypi (ver_bump:bool=True, repository:str='pypi')

Create and upload Python package to PyPI

Type Default Details
ver_bump bool True Bump version
repository str pypi Respository to upload pypi, testpypi or other location defined in ~/.pypirc

Other Shortcuts


prepare

 prepare ()

Export, test, and clean notebooks

Help

Generate help for all console scripts


chelp

 chelp ()

Show help for all console scripts

chelp()
nbdev_bump_version              Increment version in settings.ini by one
nbdev_changelog                 Create a CHANGELOG.md file from closed and labeled GitHub issues
nbdev_clean                     Clean all notebooks in `fname` to avoid merge conflicts
nbdev_conda                     Create and upload a conda package
nbdev_create_config             Create a config file
nbdev_deploy                    Deploy docs to GitHub Pages
nbdev_docs                      Generate docs
nbdev_export                    Export notebooks in `path` to Python modules
nbdev_filter                    A notebook filter for Quarto
nbdev_fix                       Create working notebook from conflicted notebook `nbname`
nbdev_ghp_deploy                Deploy docs in `doc_path` from settings.ini to GitHub Pages
nbdev_help                      Show help for all console scripts
nbdev_install                   Install Quarto and the current library
nbdev_install_hooks             Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
nbdev_install_quarto            Install latest Quarto on macOS or Linux, prints instructions for Windows
nbdev_merge                     Git merge driver for notebooks
nbdev_migrate                   Convert all directives and callouts in `fname` from v1 to v2
nbdev_new                       Create a new project from the current git repo
nbdev_prepare                   Export, test, and clean notebooks
nbdev_preview                   Start a local docs webserver
nbdev_pypi                      Create and upload Python package to PyPI
nbdev_quarto                    Create Quarto docs and README.md
nbdev_readme                    Render README.md from index.ipynb
nbdev_release                   Release both conda and PyPI packages
nbdev_release_gh                Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
nbdev_release_git               Tag and create a release in GitHub for the current version
nbdev_sidebar                   Create sidebar.yml
nbdev_test                      Test in parallel notebooks matching `fname`, passing along `flags`
nbdev_trust                     Trust notebooks matching `fname`
nbdev_update                    Propagate change in modules matching `fname` to notebooks that created them