From d61ecb154cf287732ad23c8a99597047cc7cd7a4 Mon Sep 17 00:00:00 2001 From: deven367 Date: Sun, 12 Nov 2023 14:19:21 -0500 Subject: [PATCH] fixes #1381 --- README.md | 57 +++++++++++++++++++-------------------- nbs/getting_started.ipynb | 57 +++++++++++++++++++-------------------- 2 files changed, 56 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index 10f81e9ec..5cee6d19d 100644 --- a/README.md +++ b/README.md @@ -82,35 +82,34 @@ available commands: !nbdev_help ``` - 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 a `meta.yaml` file ready to be built into a package, and optionally build and upload it - nbdev_create_config Create a config file. - nbdev_deploy Deploy docs to GitHub Pages - nbdev_docs Create Quarto docs and README.md - 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_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 an nbdev project. - nbdev_prepare Export, test, and clean notebooks, and render README if needed - nbdev_preview Preview docs locally - nbdev_proc_nbs Process notebooks in `path` for docs rendering - nbdev_pypi Create and upload Python package to PyPI - nbdev_readme None - nbdev_release_both 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 `path`, passing along `flags` - nbdev_trust Trust notebooks matching `fname` - nbdev_update Propagate change in modules matching `fname` to notebooks that created them + 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 a `meta.yaml` file ready to be built into a package, and optionally build and upload it + nbdev_create_config Create a config file. + nbdev_docs Create Quarto docs and README.md + 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_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 markdown and notebook files in `path` from v1 to v2 + nbdev_new Create an nbdev project. + nbdev_prepare Export, test, and clean notebooks, and render README if needed + nbdev_preview Preview docs locally + nbdev_proc_nbs Process notebooks in `path` for docs rendering + nbdev_pypi Create and upload Python package to PyPI + nbdev_readme Create README.md from readme_nb (index.ipynb by default) + nbdev_release_both 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 `path`, passing along `flags` + nbdev_trust Trust notebooks matching `fname` + nbdev_update Propagate change in modules matching `fname` to notebooks that created them ## FAQ diff --git a/nbs/getting_started.ipynb b/nbs/getting_started.ipynb index c1c70a138..723f7c8d4 100644 --- a/nbs/getting_started.ipynb +++ b/nbs/getting_started.ipynb @@ -129,35 +129,34 @@ "name": "stdout", "output_type": "stream", "text": [ - "\u001b[1m\u001b[94mnbdev_bump_version\u001b[0m Increment version in settings.ini by one\n", - "\u001b[1m\u001b[94mnbdev_changelog\u001b[0m Create a CHANGELOG.md file from closed and labeled GitHub issues\n", - "\u001b[1m\u001b[94mnbdev_clean\u001b[0m Clean all notebooks in `fname` to avoid merge conflicts\n", - "\u001b[1m\u001b[94mnbdev_conda\u001b[0m Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it\n", - "\u001b[1m\u001b[94mnbdev_create_config\u001b[0m Create a config file.\n", - "\u001b[1m\u001b[94mnbdev_deploy\u001b[0m Deploy docs to GitHub Pages\n", - "\u001b[1m\u001b[94mnbdev_docs\u001b[0m Create Quarto docs and README.md\n", - "\u001b[1m\u001b[94mnbdev_export\u001b[0m Export notebooks in `path` to Python modules\n", - "\u001b[1m\u001b[94mnbdev_filter\u001b[0m A notebook filter for Quarto\n", - "\u001b[1m\u001b[94mnbdev_fix\u001b[0m Create working notebook from conflicted notebook `nbname`\n", - "\u001b[1m\u001b[94mnbdev_help\u001b[0m Show help for all console scripts\n", - "\u001b[1m\u001b[94mnbdev_install\u001b[0m Install Quarto and the current library\n", - "\u001b[1m\u001b[94mnbdev_install_hooks\u001b[0m Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks\n", - "\u001b[1m\u001b[94mnbdev_install_quarto\u001b[0m Install latest Quarto on macOS or Linux, prints instructions for Windows\n", - "\u001b[1m\u001b[94mnbdev_merge\u001b[0m Git merge driver for notebooks\n", - "\u001b[1m\u001b[94mnbdev_migrate\u001b[0m Convert all directives and callouts in `fname` from v1 to v2\n", - "\u001b[1m\u001b[94mnbdev_new\u001b[0m Create an nbdev project.\n", - "\u001b[1m\u001b[94mnbdev_prepare\u001b[0m Export, test, and clean notebooks, and render README if needed\n", - "\u001b[1m\u001b[94mnbdev_preview\u001b[0m Preview docs locally\n", - "\u001b[1m\u001b[94mnbdev_proc_nbs\u001b[0m Process notebooks in `path` for docs rendering\n", - "\u001b[1m\u001b[94mnbdev_pypi\u001b[0m Create and upload Python package to PyPI\n", - "\u001b[1m\u001b[94mnbdev_readme\u001b[0m None\n", - "\u001b[1m\u001b[94mnbdev_release_both\u001b[0m Release both conda and PyPI packages\n", - "\u001b[1m\u001b[94mnbdev_release_gh\u001b[0m Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`\n", - "\u001b[1m\u001b[94mnbdev_release_git\u001b[0m Tag and create a release in GitHub for the current version\n", - "\u001b[1m\u001b[94mnbdev_sidebar\u001b[0m Create sidebar.yml\n", - "\u001b[1m\u001b[94mnbdev_test\u001b[0m Test in parallel notebooks matching `path`, passing along `flags`\n", - "\u001b[1m\u001b[94mnbdev_trust\u001b[0m Trust notebooks matching `fname`\n", - "\u001b[1m\u001b[94mnbdev_update\u001b[0m Propagate change in modules matching `fname` to notebooks that created them\n" + "\u001b[1m\u001b[94mnbdev_bump_version\u001b[22m\u001b[39m Increment version in settings.ini by one\n", + "\u001b[1m\u001b[94mnbdev_changelog\u001b[22m\u001b[39m Create a CHANGELOG.md file from closed and labeled GitHub issues\n", + "\u001b[1m\u001b[94mnbdev_clean\u001b[22m\u001b[39m Clean all notebooks in `fname` to avoid merge conflicts\n", + "\u001b[1m\u001b[94mnbdev_conda\u001b[22m\u001b[39m Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it\n", + "\u001b[1m\u001b[94mnbdev_create_config\u001b[22m\u001b[39m Create a config file.\n", + "\u001b[1m\u001b[94mnbdev_docs\u001b[22m\u001b[39m Create Quarto docs and README.md\n", + "\u001b[1m\u001b[94mnbdev_export\u001b[22m\u001b[39m Export notebooks in `path` to Python modules\n", + "\u001b[1m\u001b[94mnbdev_filter\u001b[22m\u001b[39m A notebook filter for Quarto\n", + "\u001b[1m\u001b[94mnbdev_fix\u001b[22m\u001b[39m Create working notebook from conflicted notebook `nbname`\n", + "\u001b[1m\u001b[94mnbdev_help\u001b[22m\u001b[39m Show help for all console scripts\n", + "\u001b[1m\u001b[94mnbdev_install\u001b[22m\u001b[39m Install Quarto and the current library\n", + "\u001b[1m\u001b[94mnbdev_install_hooks\u001b[22m\u001b[39m Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks\n", + "\u001b[1m\u001b[94mnbdev_install_quarto\u001b[22m\u001b[39m Install latest Quarto on macOS or Linux, prints instructions for Windows\n", + "\u001b[1m\u001b[94mnbdev_merge\u001b[22m\u001b[39m Git merge driver for notebooks\n", + "\u001b[1m\u001b[94mnbdev_migrate\u001b[22m\u001b[39m Convert all markdown and notebook files in `path` from v1 to v2\n", + "\u001b[1m\u001b[94mnbdev_new\u001b[22m\u001b[39m Create an nbdev project.\n", + "\u001b[1m\u001b[94mnbdev_prepare\u001b[22m\u001b[39m Export, test, and clean notebooks, and render README if needed\n", + "\u001b[1m\u001b[94mnbdev_preview\u001b[22m\u001b[39m Preview docs locally\n", + "\u001b[1m\u001b[94mnbdev_proc_nbs\u001b[22m\u001b[39m Process notebooks in `path` for docs rendering\n", + "\u001b[1m\u001b[94mnbdev_pypi\u001b[22m\u001b[39m Create and upload Python package to PyPI\n", + "\u001b[1m\u001b[94mnbdev_readme\u001b[22m\u001b[39m Create README.md from readme_nb (index.ipynb by default)\n", + "\u001b[1m\u001b[94mnbdev_release_both\u001b[22m\u001b[39m Release both conda and PyPI packages\n", + "\u001b[1m\u001b[94mnbdev_release_gh\u001b[22m\u001b[39m Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`\n", + "\u001b[1m\u001b[94mnbdev_release_git\u001b[22m\u001b[39m Tag and create a release in GitHub for the current version\n", + "\u001b[1m\u001b[94mnbdev_sidebar\u001b[22m\u001b[39m Create sidebar.yml\n", + "\u001b[1m\u001b[94mnbdev_test\u001b[22m\u001b[39m Test in parallel notebooks matching `path`, passing along `flags`\n", + "\u001b[1m\u001b[94mnbdev_trust\u001b[22m\u001b[39m Trust notebooks matching `fname`\n", + "\u001b[1m\u001b[94mnbdev_update\u001b[22m\u001b[39m Propagate change in modules matching `fname` to notebooks that created them\n" ] } ],