Skip to content

Commit fd227e3

Browse files
committed
Add Oriol's comments
1 parent 28924dc commit fd227e3

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

docs/source/contributing/jupyter_style.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This guide does not teach nor cover MyST extensively, only gives some opinionate
3535
libraries documentations. Use [sphinx cross-references](https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html)
3636
instead.
3737

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.
3939

4040
:::{caution}
4141
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
5252

5353
```
5454
{ref}`explicit text <anchor_id>`
55-
[explicit text](#anchor_id)
55+
```
56+
For instance:
57+
```
58+
{ref}`Kronecker product <GP-Kron>`
5659
```
5760

5861
#### 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.
6063

6164
```
6265
{ref}`explicit text <key:anchor_id>`
63-
[explicit text](inv:key:*:ref#anchor_id)
6466
```
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+
```
6772

6873
#### References to python objects
6974

7075
```
7176
{type}`import.path` # to show full import path
7277
{type}`~import.path` # to show only object name
7378
```
74-
7579
where type is func for functions, meth for methods, class for classes, prop for property, etc.
80+
For instance:
81+
```
82+
{class}`~pymc.gp.HSGP`
83+
```
7684

7785
Now let's continue with the MysT guidelines.
7886

0 commit comments

Comments
 (0)