Skip to content

Commit

Permalink
docs: added examples code show on gif
Browse files Browse the repository at this point in the history
  • Loading branch information
mdsanima committed Apr 2, 2022
1 parent 53beba5 commit 72d4949
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/source/modules/emoji.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
.. automodule:: mdsanima_dev.emoji
```

```{eval-rst}
.. figure:: ../_static/img/gif/emoji_show_d_04_optymize.gif
:name: show-emoji-04-gif-d
```

## Function {bdg-primary-line}`emoji_get_url_data`

```{eval-rst}
Expand All @@ -22,6 +27,11 @@
.. autofunction:: mdsanima_dev.emoji.emoji_load_json_data
```

```{eval-rst}
.. figure:: ../_static/img/gif/emoji_show_c_04_optymize.gif
:name: show-emoji-04-gif-c
```

## Class {bdg-info-line}`emoji`

```{eval-rst}
Expand All @@ -40,6 +50,11 @@ Now I will show you how to use class
{bdg-link-info-line}`show(emoji) <#class-show>` method to find out what number
each emoji has so that you can use in your code.

```{eval-rst}
.. figure:: ../_static/img/gif/emoji_show_a_04_optymize.gif
:name: show-emoji-04-gif-a
```

### Method {bdg-primary-line}`emo_stats()`

This method show statistic about emoji published on *.json* files which was
Expand Down
10 changes: 10 additions & 0 deletions docs/source/modules/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@
.. autofunction:: mdsanima_dev.utils.tools.machine
```

```{eval-rst}
.. figure:: ../_static/img/gif/machine_show_c_04_optymize.gif
:name: show-machine-04-gif-c
```

## Class {bdg-info-line}`progress`

```{eval-rst}
Expand All @@ -51,3 +56,8 @@
```{eval-rst}
.. automethod:: mdsanima_dev.utils.tools.progress.progress_bar
```

```{eval-rst}
.. figure:: ../_static/img/gif/progress_show_a_04_optymize.gif
:name: show-progress-04-gif-a
```

0 comments on commit 72d4949

Please sign in to comment.