Skip to content

Commit 50e7795

Browse files
authored
Merge pull request #8 from brianckeegan/claude/add-doc-example-images-MGAd3
2 parents b78da9f + d1e47ec commit 50e7795

42 files changed

Lines changed: 663 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,5 @@ htmlcov/
1616
venv/
1717
env/
1818
docs/_build/
19+
docs/auto_examples/
20+
docs/sg_execution_times.rst

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,17 @@ import memeplotlib as memes
2828

2929
# One-liner meme from a memegen template
3030
memes.meme("buzz", "memes", "memes everywhere")
31+
```
32+
33+
![buzz meme example](docs/_static/examples/readme_buzz_basic.png)
3134

35+
```python
3236
# Save to file
3337
memes.meme("doge", "such code", "very bug", savefig="meme.png", show=False)
3438
```
3539

40+
![doge meme example](docs/_static/examples/readme_doge_savefig.png)
41+
3642
## Features
3743

3844
### Functional API
@@ -43,11 +49,19 @@ import memeplotlib as memes
4349
# Customize text styling
4450
memes.meme("drake", "writing tests", "shipping to prod",
4551
font="impact", color="yellow")
52+
```
53+
54+
![drake functional example](docs/_static/examples/readme_drake_functional.png)
4655

56+
```python
4757
# Get figure/axes back for further customization
4858
fig, ax = memes.meme("distracted", "my project", "new framework", "me",
4959
show=False)
60+
```
5061

62+
![distracted functional example](docs/_static/examples/readme_distracted_functional.png)
63+
64+
```python
5165
# Use a local image as template
5266
memes.meme("/path/to/image.jpg", "top text", "bottom text")
5367
```
@@ -62,11 +76,17 @@ m = Meme("buzz")
6276
m.top("memes")
6377
m.bottom("memes everywhere")
6478
m.save("output.png")
79+
```
80+
81+
![buzz OO example](docs/_static/examples/readme_buzz_oo.png)
6582

83+
```python
6684
# Or chained
6785
Meme("doge").top("such code").bottom("very bug").show()
6886
```
6987

88+
![doge OO example](docs/_static/examples/readme_doge_oo.png)
89+
7090
### Memify Existing Plots
7191

7292
Turn any matplotlib figure into a meme:
@@ -80,6 +100,8 @@ ax.plot([1, 2, 3], [1, 4, 9])
80100
memes.memify(fig, "stonks")
81101
```
82102

103+
![memify stonks example](docs/_static/examples/readme_memify_stonks.png)
104+
83105
### Global Configuration
84106

85107
```python
18.3 KB
Loading
17.7 KB
Loading
31.7 KB
Loading
17.7 KB
Loading
17.7 KB
Loading
23 KB
Loading
18.3 KB
Loading
18.3 KB
Loading

0 commit comments

Comments
 (0)