Skip to content

Commit

Permalink
docs: fix some docstring reorder function position and move files
Browse files Browse the repository at this point in the history
  • Loading branch information
mdsanima committed Feb 26, 2022
1 parent be1eaeb commit 1666026
Show file tree
Hide file tree
Showing 3 changed files with 226 additions and 217 deletions.
106 changes: 0 additions & 106 deletions docs/source/module_colors.md

This file was deleted.

98 changes: 98 additions & 0 deletions docs/source/modules/colors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# Module `colors`

```{eval-rst}
.. automodule:: mdsanima_dev.colors
```

## Function `set_complex_color`

```{eval-rst}
.. autofunction:: mdsanima_dev.colors.set_complex_color
```

## Function `get_color`

```{eval-rst}
.. autofunction:: mdsanima_dev.colors.get_color
```

## Function `get_complex_color`

```{eval-rst}
.. autofunction:: mdsanima_dev.colors.get_complex_color
```

## Function `show_complex_color`

```{eval-rst}
.. autofunction:: mdsanima_dev.colors.show_complex_color
```

### Example ``show_complex_color(False)``

```{eval-rst}
This is a example screenshots of the ``Shell Terminal`` in different variants,
just for fun.
```

```{eval-rst}
.. tab-set::
.. tab-item:: Shell Acrylic
.. figure:: ../_static/screenshot/color_show_01_acrylic_a.jpg
:name: show-complex-color-false-ac-a
.. tab-item:: Shell Dark
.. figure:: ../_static/screenshot/color_show_01_dark_a.jpg
:name: show-complex-color-false-dk-a
.. tab-item:: Shell Acrylic Border
:selected:
.. figure:: ../_static/screenshot/color_show_01_acrylic_b.jpg
:name: show-complex-color-false-ac-b
.. tab-item:: Shell Dark Border
.. figure:: ../_static/screenshot/color_show_01_dark_b.jpg
:name: show-complex-color-false-dk-b
```

### Example ``show_complex_color(True)``

```{eval-rst}
This is a example screenshots of the ``Shell Terminal`` in different variants,
just for fun.
```

```{eval-rst}
.. tab-set::
.. tab-item:: Shell Acrylic
.. figure:: ../_static/screenshot/color_show_02_acrylic_a.jpg
:name: show-complex-color-true-ac-a
.. tab-item:: Shell Dark
:selected:
.. figure:: ../_static/screenshot/color_show_02_dark_a.jpg
:name: show-complex-color-true-dk-a
.. tab-item:: Shell Acrylic Border
.. figure:: ../_static/screenshot/color_show_02_acrylic_b.jpg
:name: show-complex-color-true-ac-b
.. tab-item:: Shell Dark Border
.. figure:: ../_static/screenshot/color_show_02_dark_b.jpg
:name: show-complex-color-true-dk-b
```

```{admonition} Note
Now you know what numbers you have withs different colors, now you can use
the function [``get_complex_color``](#function-get-complex-color) in your code.
```

0 comments on commit 1666026

Please sign in to comment.