-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: fix some docstring reorder function position and move files
- Loading branch information
Showing
3 changed files
with
226 additions
and
217 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
``` |
Oops, something went wrong.