Skip to content

Commit

Permalink
update doc style
Browse files Browse the repository at this point in the history
  • Loading branch information
gyli committed Oct 6, 2019
1 parent 4d9087e commit 3807a81
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
display:block;
margin-left:auto;
margin-right:auto;
margin-bottom:60px;
}
4 changes: 3 additions & 1 deletion docs/examples/block_color_and_background_color.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ fig.set_facecolor('#EEEEEE')

<img class="img_middle" alt="Block Color and Background Color" src="https://raw.githubusercontent.com/gyli/PyWaffle/master/examples/docs/block_color_and_background_color.svg?sanitize=true">

[Colormap](https://matplotlib.org/gallery/color/colormap_reference.html) could also be applied to waffle chart, which sets colors automatically. Sequential colormaps do not work with PyWaffle and only Qualitative colormaps are supported, including `Pastel1`, `Pastel2`, `Paired`, `Accent`, `Dark2`, `Set1`, `Set2`, `Set3`, `tab10`, `tab20`, `tab20b`, `tab20c`.
[Colormap](https://matplotlib.org/gallery/color/colormap_reference.html) could also be applied to waffle chart through parameter `cmap_name`, which sets colors automatically.

> **_NOTE:_** Sequential colormaps do not work with PyWaffle and only Qualitative colormaps are supported, including `Pastel1`, `Pastel2`, `Paired`, `Accent`, `Dark2`, `Set1`, `Set2`, `Set3`, `tab10`, `tab20`, `tab20b`, `tab20c`.
```python
fig = plt.figure(
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/title_label_ledend.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Parameter `labels` accepts labels in a list. If it is not specified, key of `val

Parameter `legend` accepts parameters of [matplotlib.pyplot.legend](https://matplotlib.org/api/_as_gen/matplotlib.pyplot.legend.html) in a dict.

> **_NOTE:_** Labels could also be specified in parameter `legend` under key `labels` instead.
```python
data = {'Cat1': 48, 'Cat2': 46, 'Cat3': 3}
fig = plt.figure(
Expand All @@ -31,5 +33,3 @@ fig = plt.figure(
```

<img class="img_middle" alt="Title, Label and Legend" src="https://raw.githubusercontent.com/gyli/PyWaffle/master/examples/docs/title_label_ledend.svg?sanitize=true">

> **_NOTE:_** Labels could also be specified in parameter `legend` as an item instead.

0 comments on commit 3807a81

Please sign in to comment.