Linking documents#
Referencing another lecture#
To add a link to another document in the same lecture series you can use standard markdown links.
Here is an example link:
[another document](figures)
which will render as: another document.
In many cases it can be useful to automatically use the title of the referenced page.
In this case then you should leave the title text field blank such as:
[](figures)
which will render as: Figures.
Referencing a lecture in a different lecture series#
Warning
To reference a document in a different lecture series the repo needs to have intersphinx
configured in _config.yml. Please consult the development team.
Documents in another lecture series can be referenced using {doc} links.
For example, this repository has setup intersphinx in _config.yml to provide
linking to the A First Course in Quantitative Economics with Python.
intersphinx_mapping:
intro:
- "https://intro.quantecon.org/"
- null
To setup a link you can use:
{doc}`this lecture on linear equations<intro:linear_equations>`
which will render as: this lecture on linear equations
Note
The intro: is an important part of the link. It is determined by the _config.yml settings
for intersphinx, so you may need to review _config.yml to understand what link stub to use.
In many cases it can be useful to automatically use the title of the referenced page.
This can be done by just specifying the link such as:
{doc}`intro:linear_equations`
which will use the full title of the lecture: Linear Equations and Matrix Algebra
Tip
You will note the later link doesn’t include the < and > brackets.
Standard intersphinx definitions#
The standard intersphinx definitions are:
code |
target lecture |
|---|---|
programming |
|
intro |
|
intermediate |
|
advanced |
|
jax |