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
* minor fixes to docs
* try fixing pymc-lab logo
* set first cell language to markdown
* make homepage buttons larger
* fix sponsor images
* Update docs/source/contributing/jupyter_style.md
Co-authored-by: Martina Cantaro <[email protected]>
Co-authored-by: Martina Cantaro <[email protected]>
Copy file name to clipboardExpand all lines: docs/source/contributing/jupyter_style.md
+20-6Lines changed: 20 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -29,10 +29,14 @@ the repository where the notebook is in (pymc or pymc-examples).
29
29
* When using non meaningful names such as single letters, add bullet points with a 1-2 sentence description of each variable below the equation where they are first introduced.
30
30
31
31
32
-
## Post directive
33
-
The first cell of all example notebooks should have a level 1 markdown title (that is a title with a single `#`) followed by the post directive. The syntax of the post directive is as follows:
32
+
## First cell
33
+
The first cell of all example notebooks should have a MyST target, a level 1 markdown title (that is a title with a single `#`) followed by the post directive.
34
+
The syntax is as follows:
35
+
36
+
```markdown
37
+
(notebook_id)=
38
+
# Notebook Title
34
39
35
-
```
36
40
:::{post} Aug 31, 2021
37
41
:tags: tag1, tag2, tags can have spaces, tag4
38
42
:category: level
@@ -42,15 +46,22 @@ The first cell of all example notebooks should have a level 1 markdown title (th
42
46
43
47
The date should correspond to the latest update/execution date, at least roughly (it's not a problem if the date is a few days off due to the review process before merging the PR). This will allow users to see which notebooks have been updated lately and will help the PyMC team make sure no notebook is left outdated for too long.
44
48
45
-
Tags can be anything, but we ask you to try to use [existing tags](https://github.com/pymc-devs/pymc/wiki/Categories-and-Tags-for-PyMC-Examples) to avoid the tag list from getting too long. Each notebook should
46
-
have a single category indicating the level of the notebook. Choose a category from [existing categories](https://github.com/pymc-devs/pymc/wiki/Categories-and-Tags-for-PyMC-Examples#categories).
49
+
The [MyST target](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#targets-and-cross-referencing)
50
+
is important to ease referencing and linking notebooks between each other.
51
+
52
+
Tags can be anything, but we ask you to try to use [existing tags](https://github.com/pymc-devs/pymc/wiki/Categories-and-Tags-for-PyMC-Examples)
53
+
to avoid the tag list from getting too long.
54
+
55
+
Each notebook should have a single category indicating the level of the notebook.
56
+
Choose a category from [existing categories](https://github.com/pymc-devs/pymc/wiki/Categories-and-Tags-for-PyMC-Examples#categories).
47
57
48
58
Authors should list people who authored, adapted or updated the notebook. See {ref}`jupyter_authors`
49
59
for more details.
50
60
51
61
## Code preamble
52
62
53
-
In a cell just below the cell where you imported matplotlib (usually the first one), set the ArviZ style to darkgrid (this has to be in another cell than the MPL import because of the way MPL sets its defaults):
63
+
In a cell just below the cell where you imported matplotlib and/or ArviZ (usually the first one),
64
+
set the ArviZ style to darkgrid (this has to be in another cell than the matplotlib import because of the way matplotlib sets its defaults):
54
65
55
66
```python
56
67
RANDOM_SEED=8927
@@ -122,6 +133,7 @@ and `<date>` should preferably be month and year.
122
133
123
134
authored
124
135
: for notebooks created specifically for pymc-examples
136
+
125
137
adapted
126
138
: for notebooks adapted from other sources such as books or blogposts.
127
139
It will therefore follow a different structure than the example above
@@ -130,9 +142,11 @@ adapted
130
142
```markdown
131
143
Adapted from Alice's [blogpost](blog.alice.com) by Bob and Carol on ...
132
144
```
145
+
133
146
re-executed
134
147
: for notebooks re-executed with a newer PyMC version without significant changes to the code.
135
148
It can also mention the PyMC version used to run the notebook.
149
+
136
150
updated
137
151
: for notebooks that have not only been re-executed but have also had significant updates to
138
152
their content (either code, explanations or both).
0 commit comments