Skip to content

Commit 394b9ee

Browse files
committed
DOC: use anonymous hyperlinks for embedded URLs
1 parent ab85921 commit 394b9ee

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

NEWS.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Version 0.8.0 -- 2020-10-20 -- PyPI__ -- diff__
148148
To get rid of those ugly greenish code blocks,
149149
remove ``pygments_style = 'sphinx'`` from your ``conf.py``.
150150
* Switch documentation to
151-
`insipid <https://insipid-sphinx-theme.readthedocs.io/>`_ theme by default
151+
`insipid <https://insipid-sphinx-theme.readthedocs.io/>`__ theme by default
152152
* Require Python 3.6+
153153

154154
__ https://pypi.org/project/nbsphinx/0.8.0/
@@ -166,7 +166,7 @@ Version 0.7.0 -- 2020-05-08 -- PyPI__ -- diff__
166166
``height`` and ``class`` attributes are supported.
167167
* CSS: prompts protrude into left margin if ``nbsphinx_prompt_width`` is
168168
too small. If you want to hide the prompts, use
169-
`custom CSS <https://nbsphinx.readthedocs.io/en/0.7.0/custom-css.html>`_.
169+
`custom CSS <https://nbsphinx.readthedocs.io/en/0.7.0/custom-css.html>`__.
170170

171171
__ https://pypi.org/project/nbsphinx/0.7.0/
172172
__ https://github.com/spatialaudio/nbsphinx/compare/0.6.1...0.7.0

doc/a-normal-rst-file.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,14 @@ __ subdir/a-notebook-in-a-subdir.ipynb
4747
__ subdir/a-notebook-in-a-subdir.ipynb
4848
4949
Finally, you can use `Embedded URIs`_, like this
50-
`link <subdir/a-notebook-in-a-subdir.ipynb>`_.
50+
`link <subdir/a-notebook-in-a-subdir.ipynb>`__.
5151

5252
.. _Embedded URIs: https://docutils.sourceforge.io/docs/ref/rst/
5353
restructuredtext.html#embedded-uris-and-aliases
5454

5555
.. code-block:: rst
5656
57-
like this `link <subdir/a-notebook-in-a-subdir.ipynb>`_.
57+
like this `link <subdir/a-notebook-in-a-subdir.ipynb>`__.
5858
5959
.. note::
6060

@@ -80,7 +80,7 @@ Links to Notebooks, Ye Olde Way
8080

8181
In addition to the way shown above, you can also create links to notebooks (and
8282
other Sphinx source files) with
83-
`:ref: <https://www.sphinx-doc.org/en/master/usage/referencing.html#role-ref>`_.
83+
`:ref: <https://www.sphinx-doc.org/en/master/usage/referencing.html#role-ref>`__.
8484
This has some disadvantages:
8585

8686
* It is arguably a bit more clunky.
@@ -218,7 +218,7 @@ syntax, see the section about
218218
`citations in Markdown cells <markdown-cells.ipynb#Citations>`__.
219219

220220
You can create a list of references in any reStructuredText file
221-
(or `reST cell <raw-cells.ipynb#reST>`_ in a notebook) like this:
221+
(or `reST cell <raw-cells.ipynb#reST>`__ in a notebook) like this:
222222

223223
.. code-block:: rst
224224
@@ -296,7 +296,7 @@ The following example gallery was created using:
296296

297297
.. seealso::
298298

299-
`Link Galleries in Jupyter Notebooks <gallery/gallery-with-links.ipynb>`_
299+
`Link Galleries in Jupyter Notebooks <gallery/gallery-with-links.ipynb>`__
300300

301301

302302
Thumbnail Galleries

doc/orphan.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"* ... from a [reST page](a-normal-rst-file.rst#links-to-notebooks-and-other-sphinx-source-files) using\n",
2727
"\n",
2828
" ```rst\n",
29-
" `some link text <notebookname.ipynb>`_\n",
29+
" `some link text <notebookname.ipynb>`__\n",
3030
" ```\n",
3131
"\n",
3232
"Sphinx raises a warning in case of orphaned documents:\n",

0 commit comments

Comments
 (0)