Skip to content

Commit c2b3d35

Browse files
author
Tim Hopper
committed
Clean up contributing instructions
1 parent eefa189 commit c2b3d35

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,23 @@ name:scatter-with-regression
6161
package:ggplot
6262
```
6363

64+
If you are using Jupyter lab, these are available through the `Cell Tools` left sidebar menu:
65+
```
66+
{
67+
"tags": [
68+
"ex",
69+
"name:scatter-with-regression",
70+
"package:ggplot"
71+
]
72+
}
73+
```
74+
6475
`ex` identifies the cell as an example. The `name` tag corresponds to an item in the `names` dictionary in `render.py`. The `package` tag corresponds to a package in the `packages` dict in `render.py`.
6576

66-
At the moment, the code must return a png image into the output cell. A Markdown comment can be added within triple quotes on the first line of the cell. (This currently doesn't work for `R` cells.)
77+
The site layout current allows for ~46 characters in the code window. Please keep this in mind and wrap your code to avoid too much side scrolling.
78+
79+
At the moment, the code must return a png image into the output cell. To generate image files with `plotly`, using their server is currently the only way. Please see the [getting started page](https://plot.ly/python/getting-started/) for instructions on the `.credentials` file.
80+
81+
A Markdown comment can be added within triple quotes on the first line of the cell. (This currently doesn't work for `R` cells.)
6782

68-
You can render the images to `web/index.html` by running `$ make`.
83+
You can render the images to `web/img/plots` by running `$ make`. Afterward, launch a local server (e.g. `python -m http.server`) from the `web` directory.

0 commit comments

Comments
 (0)