Merge pull request #686 from geigerfa/master

Fix documentation

Author: jph00

README.md

@@ -32,8 +32,7 @@ practices because tests and documentation are first class.
     each push and rebuild docs on each merge.
 -   **Git-friendly notebooks** with tools that clean unwanted metadata
     and render merge conflicts in a human-readable format.
--   … and much more! See the [Getting Started](#Getting-Started) section
-    below for more.
+-   … and much more!
 
 ## Install
 
@@ -138,7 +137,8 @@ strive to abide by generally accepted best practices in open-source
 software development.
 
 Make sure you have `nbdev`’s git hooks installed by running
-`nbdev_install_git_hooks` in the cloned repository.
+[nbdev_install_hooks](https://nbdev.fast.ai/clean.html#nbdev_install_hooks)
+in the cloned repository.
 
 ## Copyright
 

nbdev/clean.py

@@ -128,7 +128,7 @@ def nbdev_install_hooks():
     fn.write_text("#!/bin/bash\nnbdev_trust")
     os.chmod(fn, os.stat(fn).st_mode | stat.S_IEXEC)
     #Clean notebooks on commit/diff
-    (path/'.gitconfig').write_text("""# Generated by nbdev_install_git_hooks
+    (path/'.gitconfig').write_text("""# Generated by nbdev_install_hooks
 #
 # If you need to disable this instrumentation do:
 #   git config --local --unset include.path

nbs/11_clean.ipynb

@@ -55,7 +55,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "To avoid pointless conflicts while working with jupyter notebooks (with different execution counts or cell metadata), it is recommended to clean the notebooks before committing anything (done automatically if you install the git hooks with `nbdev_install_git_hooks`). The following functions are used to do that."
+    "To avoid pointless conflicts while working with jupyter notebooks (with different execution counts or cell metadata), it is recommended to clean the notebooks before committing anything (done automatically if you install the git hooks with `nbdev_install_hooks`). The following functions are used to do that."
    ]
   },
   {
@@ -333,7 +333,7 @@
     "    fn.write_text(\"#!/bin/bash\\nnbdev_trust\")\n",
     "    os.chmod(fn, os.stat(fn).st_mode | stat.S_IEXEC)\n",
     "    #Clean notebooks on commit/diff\n",
-    "    (path/'.gitconfig').write_text(\"\"\"# Generated by nbdev_install_git_hooks\n",
+    "    (path/'.gitconfig').write_text(\"\"\"# Generated by nbdev_install_hooks\n",
     "#\n",
     "# If you need to disable this instrumentation do:\n",
     "#   git config --local --unset include.path\n",
@@ -388,7 +388,7 @@
    "split_at_heading": true
   },
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3.9.13 64-bit",
    "language": "python",
    "name": "python3"
   }

nbs/getting_started.ipynb

@@ -28,7 +28,7 @@
     "- **Tests** written as ordinary notebook cells are run in parallel with a single command.  You have fine-grained control over which tests are run.\n",
     "- **Continuous integration** out-of-the-box with [GitHub Actions](https://github.com/features/actions) that run your tests on each push and rebuild docs on each merge.\n",
     "- **Git-friendly notebooks** with tools that clean unwanted metadata and render merge conflicts in a human-readable format.\n",
-    "- ... and much more!  See the [Getting Started](#Getting-Started) section below for more."
+    "- ... and much more!"
    ]
   },
   {
@@ -183,7 +183,7 @@
    "source": [
     "If you want to contribute to `nbdev`, be sure to review the [contributions guidelines](https://github.com/fastai/nbdev/blob/master/CONTRIBUTING.md). This project adheres to fastai's [code of conduct](https://github.com/fastai/nbdev/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. In general, we strive to abide by generally accepted best practices in open-source software development.\n",
     "\n",
-    "Make sure you have `nbdev`'s git hooks installed by running `nbdev_install_git_hooks` in the cloned repository."
+    "Make sure you have `nbdev`'s git hooks installed by running `nbdev_install_hooks` in the cloned repository."
    ]
   },
   {
@@ -203,7 +203,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3.9.13 64-bit",
    "language": "python",
    "name": "python3"
   }

nbs/tutorial.ipynb

@@ -327,9 +327,7 @@
    "outputs": [
     {
      "data": {
-      "image/svg+xml": [
-       "<svg height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\"/></svg>"
-      ],
+      "image/svg+xml": "<svg height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\"/></svg>",
       "text/plain": [
        "<IPython.core.display.SVG object>"
       ]
@@ -392,7 +390,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Now you can create your Python module. To do so, just run `nbdev_prepare` from the terminal at the root of your project folder. `nbdev_prepare` bundles the following commands together for you to test your code and build the library.  While running `nbdev_prepare` is convenient, you have the flexibility to choose these seperate pieces.\n",
+    "Now you can create your Python module. To do so, just run `nbdev_prepare` from the terminal at the root of your project folder. `nbdev_prepare` bundles the following commands together for you to test your code and build the library.  While running `nbdev_prepare` is convenient, you have the flexibility to choose these separate pieces.\n",
+    "\n",
     "- `nbdev_export`: Builds the .py modules and library from the jupyter notebook\n",
     "- `nbdev_test`: Tests all your notebooks\n",
     "- `nbdev_clean`: Cleans your notebooks to get rid of extreanous output for Github\n",
@@ -405,7 +404,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Preview The docs\n",
+    "## Preview the docs\n",
     "\n",
     "If you have not already, you should view your docs in fully rendered form to catch any mistakes.  You can preview your documentation site with the command `nbdev_preview`.  Note that your docs will build automatically in CI (discussed below)."
    ]
@@ -448,7 +447,7 @@
     "\n",
     "If you have a red cross, that means something failed. Click on the cross, then click *Details*, and you'll be able to see what failed.\n",
     "\n",
-    "#### Automatically Building Docs\n",
+    "#### Automatically building Docs\n",
     "\n",
     "CI will automatically build docs and deploy them for you.  You can see the code for this in `.github/workflows/deploy.yaml`, but you normally don't have to worry about this unless you need to customize something.  There might be certain circumstances in which your organization has disabled GitHub pages by default.  If this is the case, you can enable Github Pages by clicking on the  *Settings* tab in your repo, then click *Pages* on the left side bar.  Set \"Source\" to *`gh-pages` branch and the `/root` folder*. Once you've saved, if you refresh that page, Github will have a link to your new website. Copy that URL, and then go back to your main repo page, click \"edit\" next to the description and paste the URL into the \"website\" section. While you're there, go ahead and put in your project description too. \n",
     "\n",
@@ -1041,7 +1040,7 @@
    "split_at_heading": true
   },
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3.9.13 64-bit",
    "language": "python",
    "name": "python3"
   }