Skip to content

Commit 5ce0582

Browse files
committed
refactor: use links file
1 parent 996c22f commit 5ce0582

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

doc/source/how-to/documenting.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -985,9 +985,9 @@ them for the web, or by engineers verifying their correctness and updating them.
985985
flexibility requires a careful balance between accessibility, structure, and maintainability.
986986

987987
A recommended approach to support this goal is to author and maintain examples as plain
988-
Python scripts, but using `Jupytext <https://jupytext.readthedocs.io/en/latest/>`_ to treat those
988+
Python scripts, but using `Jupytext <Jupytext_>`_ to treat those
989989
scripts as notebooks when needed. Formatting your examples using the
990-
`light format <https://jupytext.readthedocs.io/en/latest/formats-scripts.html#the-light-format>`_
990+
`Jupytext light format <Jupytext_light_format_>`_
991991
makes them makes them fully compatible with JupyterLab, where they can be opened, edited, and
992992
executed just like traditional notebooks - all without needing a IPYNB file. Here is an example
993993
of a Jupytext light format script:

doc/source/links.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@
8585
.. _Docker: https://www.docker.com/
8686
.. _Flake8: https://flake8.pycqa.org/en/latest/
8787
.. _isort: https://pycqa.github.io/isort/
88+
.. _Jupytext: https://jupytext.readthedocs.io/en/latest/
8889
.. _numpy: https://numpy.org/
8990
.. _pandas: https://pandas.pydata.org/
9091
.. _pre-commit: https://pre-commit.com/
@@ -105,6 +106,7 @@
105106
.. _Docutils: https://docutils.sourceforge.io/
106107
.. _doctest: https://docs.python.org/3/library/doctest.html
107108
.. _Google_docstrings: https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
109+
.. _Jupytext_light_format: https://jupytext.readthedocs.io/en/latest/formats-scripts.html#the-light-format
108110
.. _Notepadpp_downloads: https://notepad-plus-plus.org/downloads/
109111
.. _Notepadpp_searching: https://npp-user-manual.org/docs/searching/
110112
.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/index.html

0 commit comments

Comments
 (0)