-
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.
fix: clean up code black formater
- Loading branch information
Showing
2 changed files
with
336 additions
and
133 deletions.
There are no files selected for viewing
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,201 @@ | ||
# Module {bdg-success-line}`table` | ||
|
||
```{eval-rst} | ||
.. automodule:: mdsanima_dev.utils.table | ||
``` | ||
|
||
## Class {bdg-info-line}`table` | ||
|
||
```{eval-rst} | ||
.. autoclass:: mdsanima_dev.utils.table.table | ||
.. automethod:: colors | ||
.. automethod:: connect | ||
``` | ||
|
||
### Method {bdg-primary-line}`headers()` | ||
|
||
```{eval-rst} | ||
.. automethod:: mdsanima_dev.utils.table.table.headers | ||
``` | ||
|
||
```{eval-rst} | ||
.. tab-set:: | ||
.. tab-item:: Shell Acrylic | ||
.. figure:: ../_static/img/screenshot/table_show_01_acrylic_a.jpg | ||
:name: show-table-01-ac-a | ||
.. tab-item:: Shell Dark | ||
.. figure:: ../_static/img/screenshot/table_show_01_dark_a.jpg | ||
:name: show-table-01-dk-a | ||
.. tab-item:: Shell Acrylic Border | ||
:selected: | ||
.. figure:: ../_static/img/screenshot/table_show_01_acrylic_b.jpg | ||
:name: show-table-01-ac-b | ||
.. tab-item:: Shell Dark Border | ||
.. figure:: ../_static/img/screenshot/table_show_01_dark_b.jpg | ||
:name: show-table-01-dk-b | ||
``` | ||
|
||
### Method {bdg-primary-line}`content()` | ||
|
||
```{eval-rst} | ||
.. automethod:: mdsanima_dev.utils.table.table.content | ||
``` | ||
|
||
```{eval-rst} | ||
.. tab-set:: | ||
.. tab-item:: Shell Acrylic | ||
.. figure:: ../_static/img/screenshot/table_show_02_acrylic_a.jpg | ||
:name: show-table-02-ac-a | ||
.. tab-item:: Shell Dark | ||
.. figure:: ../_static/img/screenshot/table_show_02_dark_a.jpg | ||
:name: show-table-02-dk-a | ||
.. tab-item:: Shell Acrylic Border | ||
:selected: | ||
.. figure:: ../_static/img/screenshot/table_show_02_acrylic_b.jpg | ||
:name: show-table-02-ac-b | ||
.. tab-item:: Shell Dark Border | ||
.. figure:: ../_static/img/screenshot/table_show_02_dark_b.jpg | ||
:name: show-table-02-dk-b | ||
``` | ||
|
||
## Class {bdg-info-line}`table_elem` | ||
|
||
```{eval-rst} | ||
.. autoclass:: mdsanima_dev.utils.table.table_elem | ||
``` | ||
|
||
### Method {bdg-primary-line}`bot()` | ||
|
||
```{eval-rst} | ||
.. automethod:: mdsanima_dev.utils.table.table_elem.bot | ||
``` | ||
|
||
### Method {bdg-primary-line}`con()` | ||
|
||
```{eval-rst} | ||
.. automethod:: mdsanima_dev.utils.table.table_elem.con | ||
``` | ||
|
||
### Method {bdg-primary-line}`hed()` | ||
|
||
```{eval-rst} | ||
.. automethod:: mdsanima_dev.utils.table.table_elem.hed | ||
``` | ||
|
||
### Method {bdg-primary-line}`mid()` | ||
|
||
```{eval-rst} | ||
.. automethod:: mdsanima_dev.utils.table.table_elem.mid | ||
``` | ||
|
||
### Method {bdg-primary-line}`top()` | ||
|
||
```{eval-rst} | ||
.. automethod:: mdsanima_dev.utils.table.table_elem.top | ||
``` | ||
|
||
### Example Usage | ||
|
||
This is a example function to make a colored table on class | ||
{bdg-link-info-line}`table_elem <#class-table-elem>` method. These example show | ||
three different tables that are not linked together. | ||
|
||
```python | ||
from mdsanima_dev.utils.table import table_elem | ||
def my_table(): | ||
t = table_elem(40) | ||
t.top(64) | ||
t.hed(64, "I love Python".center(62), 155) | ||
t.bot(64) | ||
t.top(64) | ||
t.con(64, "Python", "hello world", 197, 203) | ||
t.bot(64) | ||
t.top(64) | ||
t.hed(64, "mdsanima.com".center(62), 87) | ||
t.bot(64) | ||
``` | ||
|
||
```{eval-rst} | ||
.. tab-set:: | ||
.. tab-item:: Shell Acrylic | ||
.. figure:: ../_static/img/screenshot/table_show_03_acrylic_a.jpg | ||
:name: show-table-03-ac-a | ||
.. tab-item:: Shell Dark | ||
.. figure:: ../_static/img/screenshot/table_show_03_dark_a.jpg | ||
:name: show-table-03-dk-a | ||
.. tab-item:: Shell Acrylic Border | ||
:selected: | ||
.. figure:: ../_static/img/screenshot/table_show_03_acrylic_b.jpg | ||
:name: show-table-03-ac-b | ||
.. tab-item:: Shell Dark Border | ||
.. figure:: ../_static/img/screenshot/table_show_03_dark_b.jpg | ||
:name: show-table-03-dk-b | ||
``` | ||
|
||
This example shows how to create linked tables. | ||
|
||
```python | ||
from mdsanima_dev.utils.table import table_elem | ||
def my_table(): | ||
t = table_elem(40) | ||
t.top(64) | ||
t.hed(64, "I love Python".center(63), 155) | ||
t.mid(64) | ||
t.con(64, "mdsanima.com".rjust(28), "hello world", 197, 203) | ||
t.con(64, "development".rjust(28), "in progress", 87, 86) | ||
t.con(64, "documentation".rjust(28), "sphinx", 31, 61) | ||
t.mid(64) | ||
t.hed(64, "https://github.com/mdsanima-dev/mdsanima-dev".center(63), 33) | ||
t.bot(64) | ||
``` | ||
|
||
```{eval-rst} | ||
.. tab-set:: | ||
.. tab-item:: Shell Acrylic | ||
.. figure:: ../_static/img/screenshot/table_show_04_acrylic_a.jpg | ||
:name: show-table-04-ac-a | ||
.. tab-item:: Shell Dark | ||
.. figure:: ../_static/img/screenshot/table_show_04_dark_a.jpg | ||
:name: show-table-04-dk-a | ||
.. tab-item:: Shell Acrylic Border | ||
:selected: | ||
.. figure:: ../_static/img/screenshot/table_show_04_acrylic_b.jpg | ||
:name: show-table-04-ac-b | ||
.. tab-item:: Shell Dark Border | ||
.. figure:: ../_static/img/screenshot/table_show_04_dark_b.jpg | ||
:name: show-table-04-dk-b | ||
``` |
Oops, something went wrong.