Skip to content

Commit

Permalink
added docs re: Colab
Browse files Browse the repository at this point in the history
  • Loading branch information
hamelsmu committed Aug 11, 2020
1 parent 95cc7fa commit 2fe4673
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions nbs/index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Because both the documentation and code for nbdev is written in notebooks, you can optionally view and run nbdev documentation in [Google Colab](https://colab.research.google.com/). You can enable Google Colab badges that link to the appropriate notebook of your docs in your GitHub repository. \n",
"Because both the documentation and code for nbdev is written in notebooks, you can optionally view and run nbdev documentation in [Google Colab](https://colab.research.google.com/). You can enable Google Colab badges that link to the appropriate notebook(s) in your GitHub repository. \n",
"\n",
"You can toggle the this feature on or off in your `/_config.yml` file:\n",
"\n",
Expand All @@ -339,8 +339,7 @@
" colab: true\n",
"```\n",
"\n",
"Furthermore, If you only want to hide a badge on an individual document, you can set the front matter `hide_colab_badge: true`. For example, if you want a Colab badge to show up on all docs created with notebooks, except for the notebook `nbs/06_cli.ipynb`, your front matter (in the form of a markdown cell at the top of your notebook should look like this:\n",
"\n",
"Furthermore, If you want to hide a badge on an individual document but still show badges elsewhere, you can set the front matter `hide_colab_badge: true`. For example, if you wanted to hide the Colab badge from showing up on the notebook `nbs/06_cli.ipynb`, your front matter (in the form of a markdown cell at the top of the notebook will look like this:\n",
"\n",
"```\n",
"# Command line functions\n",
Expand All @@ -350,7 +349,7 @@
"- hide_colab_badge: true\n",
"```\n",
"\n",
"Note how in the above example, in addition to a title `Command line functions` (formatted as a markdown heading) and the summary `Console commands added by the nbdev library` (formatted as a markdown note) the additional option `hide_colab_badge` is a list item. It is important that the list item is separated from the summary by 2 newlines as shown above, in the same notebook markdown cell."
"Note how in the above example, th `Command line functions` (formatted as a markdown heading) and the summary `Console commands added by the nbdev library` (formatted as a markdown note) the additional option `hide_colab_badge` is a list item. It is important that the list item is separated from the summary by 2 newlines as shown above, in the same notebook markdown cell."
]
},
{
Expand Down

1 comment on commit 2fe4673

@review-notebook-app
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Jupyter notebook diffs for this commit on  ReviewNB

You can open a pull request to discuss changes and offer feedback.


Powered by ReviewNB

Please sign in to comment.