Skip to content

Commit 1feb568

Browse files
jph00jph00
committed
docs
1 parent 591216b commit 1feb568

1 file changed

Lines changed: 35 additions & 35 deletions

File tree

‎nbs/getting_started.ipynb‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -148,46 +148,46 @@
148148
"name": "stdout",
149149
"output_type": "stream",
150150
"text": [
151-
"\u001b[1m\u001b[94mnb_export\u001b[22m\u001b[39m Export a single nbdev notebook to a python script.\r\n",
152-
"\u001b[1m\u001b[94mnbdev_bump_version\u001b[22m\u001b[39m Increment version in __init__.py by one\r\n",
153-
"\u001b[1m\u001b[94mnbdev_changelog\u001b[22m\u001b[39m Create a CHANGELOG.md file from closed and labeled GitHub issues\r\n",
154-
"\u001b[1m\u001b[94mnbdev_clean\u001b[22m\u001b[39m Clean all notebooks in `fname` to avoid merge conflicts\r\n",
155-
"\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\r\n",
156-
"\u001b[1m\u001b[94mnbdev_contributing\u001b[22m\u001b[39m Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist.\r\n",
157-
"\u001b[1m\u001b[94mnbdev_create_config\u001b[22m\u001b[39m Create a pyproject.toml config file.\r\n",
158-
"\u001b[1m\u001b[94mnbdev_docs\u001b[22m\u001b[39m Create Quarto docs and README.md\r\n",
159-
"\u001b[1m\u001b[94mnbdev_export\u001b[22m\u001b[39m Export notebooks in `path` to Python modules\r\n",
160-
"\u001b[1m\u001b[94mnbdev_filter\u001b[22m\u001b[39m A notebook filter for Quarto\r\n",
161-
"\u001b[1m\u001b[94mnbdev_fix\u001b[22m\u001b[39m Create working notebook from conflicted notebook `nbname`\r\n",
162-
"\u001b[1m\u001b[94mnbdev_help\u001b[22m\u001b[39m Show help for all console scripts\r\n",
163-
"\u001b[1m\u001b[94mnbdev_install\u001b[22m\u001b[39m Install Quarto and the current library\r\n",
164-
"\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\r\n",
165-
"\u001b[1m\u001b[94mnbdev_install_quarto\u001b[22m\u001b[39m Install latest Quarto on macOS or Linux, prints instructions for Windows\r\n",
166-
"\u001b[1m\u001b[94mnbdev_merge\u001b[22m\u001b[39m Git merge driver for notebooks\r\n",
167-
"\u001b[1m\u001b[94mnbdev_migrate\u001b[22m\u001b[39m Convert all markdown and notebook files in `path` from v1 to v2\r\n",
168-
"\u001b[1m\u001b[94mnbdev_migrate_config\u001b[22m\u001b[39m Migrate settings.ini to pyproject.toml\r\n",
169-
"\u001b[1m\u001b[94mnbdev_new\u001b[22m\u001b[39m Create an nbdev project.\r\n",
170-
"\u001b[1m\u001b[94mnbdev_prepare\u001b[22m\u001b[39m Export, test, and clean notebooks, and render README if needed\r\n",
171-
"\u001b[1m\u001b[94mnbdev_preview\u001b[22m\u001b[39m Preview docs locally\r\n",
172-
"\u001b[1m\u001b[94mnbdev_proc_nbs\u001b[22m\u001b[39m Process notebooks in `path` for docs rendering\r\n",
173-
"\u001b[1m\u001b[94mnbdev_pypi\u001b[22m\u001b[39m Create and upload Python package to PyPI\r\n",
174-
"\u001b[1m\u001b[94mnbdev_readme\u001b[22m\u001b[39m Create README.md from readme_nb (index.ipynb by default)\r\n",
175-
"\u001b[1m\u001b[94mnbdev_release_both\u001b[22m\u001b[39m Release both conda and PyPI packages\r\n",
176-
"\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`\r\n",
177-
"\u001b[1m\u001b[94mnbdev_release_git\u001b[22m\u001b[39m Tag and create a release in GitHub for the current version\r\n",
178-
"\u001b[1m\u001b[94mnbdev_requirements\u001b[22m\u001b[39m Writes a `requirements.txt` file to `directory` based on pyproject.toml.\r\n",
179-
"\u001b[1m\u001b[94mnbdev_sidebar\u001b[22m\u001b[39m Create sidebar.yml\r\n",
180-
"\u001b[1m\u001b[94mnbdev_test\u001b[22m\u001b[39m Test in parallel notebooks matching `path`, passing along `flags`\r\n",
181-
"\u001b[1m\u001b[94mnbdev_trust\u001b[22m\u001b[39m Trust notebooks matching `fname`.\r\n",
182-
"\u001b[1m\u001b[94mnbdev_update\u001b[22m\u001b[39m Propagate change in modules matching `fname` to notebooks that created them\r\n",
183-
"\u001b[1m\u001b[94mnbdev_update_license\u001b[22m\u001b[39m Allows you to update the license of your project.\r\n",
184-
"\u001b[1m\u001b[94mwatch_export\u001b[22m\u001b[39m Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available\r\n"
151+
"\u001b[1m\u001b[94mnb-export\u001b[22m\u001b[39m Export a single nbdev notebook to a python script.\r\n",
152+
"\u001b[1m\u001b[94mnbdev-bump-version\u001b[22m\u001b[39m Increment version in __init__.py by one\r\n",
153+
"\u001b[1m\u001b[94mnbdev-changelog\u001b[22m\u001b[39m Create a CHANGELOG.md file from closed and labeled GitHub issues\r\n",
154+
"\u001b[1m\u001b[94mnbdev-clean\u001b[22m\u001b[39m Clean all notebooks in `fname` to avoid merge conflicts\r\n",
155+
"\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\r\n",
156+
"\u001b[1m\u001b[94mnbdev-contributing\u001b[22m\u001b[39m Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist.\r\n",
157+
"\u001b[1m\u001b[94mnbdev-create-config\u001b[22m\u001b[39m Create a pyproject.toml config file.\r\n",
158+
"\u001b[1m\u001b[94mnbdev-docs\u001b[22m\u001b[39m Create Quarto docs and README.md\r\n",
159+
"\u001b[1m\u001b[94mnbdev-export\u001b[22m\u001b[39m Export notebooks in `path` to Python modules\r\n",
160+
"\u001b[1m\u001b[94mnbdev-filter\u001b[22m\u001b[39m A notebook filter for Quarto\r\n",
161+
"\u001b[1m\u001b[94mnbdev-fix\u001b[22m\u001b[39m Create working notebook from conflicted notebook `nbname`\r\n",
162+
"\u001b[1m\u001b[94mnbdev-help\u001b[22m\u001b[39m Show help for all console scripts\r\n",
163+
"\u001b[1m\u001b[94mnbdev-install\u001b[22m\u001b[39m Install Quarto and the current library\r\n",
164+
"\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\r\n",
165+
"\u001b[1m\u001b[94mnbdev-install-quarto\u001b[22m\u001b[39m Install latest Quarto on macOS or Linux, prints instructions for Windows\r\n",
166+
"\u001b[1m\u001b[94mnbdev-merge\u001b[22m\u001b[39m Git merge driver for notebooks\r\n",
167+
"\u001b[1m\u001b[94mnbdev-migrate\u001b[22m\u001b[39m Convert all markdown and notebook files in `path` from v1 to v2\r\n",
168+
"\u001b[1m\u001b[94mnbdev-migrate-config\u001b[22m\u001b[39m Migrate settings.ini to pyproject.toml\r\n",
169+
"\u001b[1m\u001b[94mnbdev-new\u001b[22m\u001b[39m Create an nbdev project.\r\n",
170+
"\u001b[1m\u001b[94mnbdev-prepare\u001b[22m\u001b[39m Export, test, and clean notebooks, and render README if needed\r\n",
171+
"\u001b[1m\u001b[94mnbdev-preview\u001b[22m\u001b[39m Preview docs locally\r\n",
172+
"\u001b[1m\u001b[94mnbdev-proc-nbs\u001b[22m\u001b[39m Process notebooks in `path` for docs rendering\r\n",
173+
"\u001b[1m\u001b[94mnbdev-pypi\u001b[22m\u001b[39m Create and upload Python package to PyPI\r\n",
174+
"\u001b[1m\u001b[94mnbdev-readme\u001b[22m\u001b[39m Create README.md from readme_nb (index.ipynb by default)\r\n",
175+
"\u001b[1m\u001b[94mnbdev-release-both\u001b[22m\u001b[39m Release both conda and PyPI packages\r\n",
176+
"\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`\r\n",
177+
"\u001b[1m\u001b[94mnbdev-release-git\u001b[22m\u001b[39m Tag and create a release in GitHub for the current version\r\n",
178+
"\u001b[1m\u001b[94mnbdev-requirements\u001b[22m\u001b[39m Writes a `requirements.txt` file to `directory` based on pyproject.toml.\r\n",
179+
"\u001b[1m\u001b[94mnbdev-sidebar\u001b[22m\u001b[39m Create sidebar.yml\r\n",
180+
"\u001b[1m\u001b[94mnbdev-test\u001b[22m\u001b[39m Test in parallel notebooks matching `path`, passing along `flags`\r\n",
181+
"\u001b[1m\u001b[94mnbdev-trust\u001b[22m\u001b[39m Trust notebooks matching `fname`.\r\n",
182+
"\u001b[1m\u001b[94mnbdev-update\u001b[22m\u001b[39m Propagate change in modules matching `fname` to notebooks that created them\r\n",
183+
"\u001b[1m\u001b[94mnbdev-update-license\u001b[22m\u001b[39m Allows you to update the license of your project.\r\n",
184+
"\u001b[1m\u001b[94mwatch-export\u001b[22m\u001b[39m Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available\r\n"
185185
]
186186
}
187187
],
188188
"source": [
189189
"#| exec_doc\n",
190-
"!nbdev_help"
190+
"!nbdev-help"
191191
]
192192
},
193193
{

0 commit comments

Comments
 (0)