Skip to content

Commit db05e13

Browse files
committed
apply review fixes
1 parent 564541a commit db05e13

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

doc/source/index.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -317,14 +317,18 @@ Pygments.
317317

318318
Downloading the code as a script
319319
--------------------------------
320+
320321
Jupyter Sphinx includes 2 roles that can be used to download the code embedded in a document:
321-
``:jupyter-download:script:`` (for a raw script file) and ``:jupyter-download:notebook:`` (for
322-
a Jupyter notebook). For example, to download all the code from this document as a script we
322+
``:jupyter-download:script:`` (for a raw script file) and ``:jupyter-download:notebook:`` or ``:jupyter-download:nb:`` (for
323+
a Jupyter notebook).
324+
325+
These roles are equivalent to the standard sphinx `download role <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-download>`__, **except** the extension of the file should not be given.
326+
For example, to download all the code from this document as a script we
323327
would use::
324328

325-
:jupyter-download:script:`index`
329+
:jupyter-download:script:`click to download <index>`
326330

327-
Which produces a link like this: :jupyter-download:script:`index`. The name that the role is
331+
Which produces a link like this: :jupyter-download:script:`click to download <index>`. The target that the role is
328332
applied to (``index`` in this case) is the name of the document for which you wish to download
329333
the code. If a document contains ``jupyter-kernel`` directives with ``:id:`` specified, then
330334
the name provided to ``:id:`` can be used to get the code for the cells belonging to the

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
sphinx==1.8.5
1+
sphinx==2.4.4
22
ipywidgets>=7.0.0
33
IPython
44
nbconvert>=5.4

0 commit comments

Comments
 (0)