You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/contributing/jupyter_style.md
+15-7Lines changed: 15 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ This guide does not teach nor cover MyST extensively, only gives some opinionate
35
35
libraries documentations. Use [sphinx cross-references](https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html)
36
36
instead.
37
37
38
-
* For instance, to link to another notebook, you could use an explicit link in the markdown text: "this model uses the \[Kronecker product](GP-Kron.myst.md)". See {ref}`this page <myst:syntax/targets>` for more details.
38
+
* For instance, to link to another notebook, you could use an explicit link in the markdown text: "this model uses the \{ref}`Kronecker product <GP-Kron>`". See {ref}`this page <myst:syntax/targets>` for more details.
39
39
40
40
:::{caution}
41
41
Using urls links breaks self referencing in versioned docs! And at the same time they are
@@ -52,27 +52,35 @@ That is, notebooks in pymc-examples referring to other notebooks in pymc-example
52
52
53
53
```
54
54
{ref}`explicit text <anchor_id>`
55
-
[explicit text](#anchor_id)
55
+
```
56
+
For instance:
57
+
```
58
+
{ref}`Kronecker product <GP-Kron>`
56
59
```
57
60
58
61
#### References to targets of other projects
59
-
These can be to any project defined in the [intersphinx mapping](https://github.com/pymc-devs/pymc-examples/blob/main/examples/conf.py#L175). For example, from pymc-examples to pymc main docs, or to arviz docs or to matplotlib docs; it doesn't matter when it comes to syntax.
62
+
These can be to any project defined in the [intersphinx mapping](https://github.com/pymc-devs/pymc/blob/main/docs/source/conf.py#L300-L312). For example, from pymc-examples to pymc main docs, or to arviz docs or to matplotlib docs; it doesn't matter when it comes to syntax.
60
63
61
64
```
62
65
{ref}`explicit text <key:anchor_id>`
63
-
[explicit text](inv:key:*:ref#anchor_id)
64
66
```
65
-
66
-
where key is one of the keys defined in the [intersphinx mapping](https://github.com/pymc-devs/pymc-examples/blob/main/examples/conf.py#L175), such as `pymc`, `arviz`, `numpy`...
67
+
where key is one of the keys defined in the [intersphinx mapping](https://github.com/pymc-devs/pymc/blob/main/docs/source/conf.py#L300-L312), such as `pymc`, `arviz`, `numpy`...
68
+
For instance:
69
+
```
70
+
{ref}`ArviZ `plot_hdi` <arviz:plot_hdi>`
71
+
```
67
72
68
73
#### References to python objects
69
74
70
75
```
71
76
{type}`import.path` # to show full import path
72
77
{type}`~import.path` # to show only object name
73
78
```
74
-
75
79
where type is func for functions, meth for methods, class for classes, prop for property, etc.
0 commit comments