File: code_links.rst

package info (click to toggle)
nb2plots 0.7.2-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,160 kB
  • sloc: python: 5,223; makefile: 225
file content (28 lines) | stat: -rw-r--r-- 699 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
.. _code-links-documentation:

##############################
Using the code-links directive
##############################

The ``code-links`` directive is a short cut for adding links to your ReST page
pointing to Python code files and Jupyter notebooks.  When Sphinx sees this
directive, it converts the ReST page to a Python code file and notebooks, and
add links to these files in the built HTML.  Use like this:

.. code-block:: rest

    .. code-links::

Here is an example, generating very boring code and notebooks:

.. code-links::

.. _code-links-directive:

********************
code-links directive
********************

.. automodule:: nb2plots.codelinks

.. include:: links_names.inc