docs(gif): add gif animation closes #10

sphinx documentation for all modules closes #2
mdsanima-dev · Aug 13, 2021 · de8e9ca · de8e9ca
1 parent 7dfec4c
commit de8e9ca
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -14,7 +14,9 @@ modules. So let me show something.
 
 This Python Pacage developed by Marcin Różewski aka
 [MDSANIM](https://mdsanima.com) includes several useful modules thats he uses
-in various projects.
+in various projects. Docomentation for **mdsanima_dev** Python Package
+is available at [docs mdsanima_dev](https://mdsanima-dev.github.io/mdsanima-dev/)
+be sure to check it.
 
 ## Installation
 
@@ -57,7 +59,8 @@ python3 setup.py install
 
 ## Develempent
 
-Help instruction for development.
+Help instruction for development. Check [documentation](https://mdsanima-dev.github.io/mdsanima-dev/docs/html/development.html)
+for workflow release and more info.
 
 ### Build documentation
 
@@ -87,6 +90,10 @@ For checking if everything is ok:
 standard-version release-test
 ```
 
+## Showcase
+
+![python_mdsanima_dev_small_fast](https://user-images.githubusercontent.com/3817871/129311978-e934ab26-85d9-49a1-97a7-dd5eb26b2c72.gif)
+
 ## Connect With Me
 
 Hi there, I'm Marcin Różewski aka [MDSANIMA](https://mdsanima.com).

diff --git a/docs/source/module_emoji.md b/docs/source/module_emoji.md
@@ -4,6 +4,11 @@
 .. automodule:: mdsanima_dev.emoji
 ```
 
+```{eval-rst}
+.. figure:: _static/gif/emoji_show_d_04_optymize.gif
+    :name: show-emoji-04-gif-d
+```
+
 ## Function `emoji_get_url_data`
 
 ```{eval-rst}
@@ -22,6 +27,11 @@
 .. autofunction:: mdsanima_dev.emoji.emoji_load_json_data
 ```
 
+```{eval-rst}
+.. figure:: _static/gif/emoji_show_c_04_optymize.gif
+    :name: show-emoji-04-gif-c
+```
+
 ## Class `emoji`
 
 ```{eval-rst}
@@ -49,6 +59,11 @@ Check first method
 [``all method``](#all-method).
 ```
 
+```{eval-rst}
+.. figure:: _static/gif/emoji_show_a_04_optymize.gif
+    :name: show-emoji-04-gif-a
+```
+
 ### Method ``emo_stats()``
 
 This method show statistic about emoji published on json which was retrieved

diff --git a/docs/source/module_tools.md b/docs/source/module_tools.md
@@ -28,6 +28,11 @@
 .. autofunction:: mdsanima_dev.utils.tools.machine
 ```
 
+```{eval-rst}
+.. figure:: _static/gif/machine_show_c_04_optymize.gif
+    :name: show-machine-04-gif-c
+```
+
 ## Class `progress`
 
 ```{eval-rst}
@@ -51,3 +56,8 @@
 ```{eval-rst}
 .. automethod:: mdsanima_dev.utils.tools.progress.progress_bar
 ```
+
+```{eval-rst}
+.. figure:: _static/gif/progress_show_a_04_optymize.gif
+    :name: show-progress-04-gif-a
+```