Skip to content

Commit

Permalink
docs: add png logo and docstring fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mdsanima committed Apr 7, 2022
1 parent 67845d6 commit 91b25e8
Show file tree
Hide file tree
Showing 64 changed files with 58 additions and 26 deletions.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/_static/logo_mdsanima_default_14-lime.svg
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@
templates_path = ["_templates"]
exclude_patterns = ["_images"]
html_static_path = ["_static"]
html_css_files = ["css/furo-mdsanima.css"]
html_js_files = ["js/furo-mdsanima.js"]
html_css_files = ["mdsanima.css"]
html_js_files = ["mdsanima.js"]

# theme options
html_theme = "furo"
html_logo = "_static/svg/logo_mdsanima_default_14-lime.svg"
html_favicon = "_static/svg/logo_mdsanima_default_14-lime.svg"
html_logo = "_static/logo_mdsanima_default_14-lime.svg"
html_favicon = "_static/logo_mdsanima_default_14-lime.svg"

# html options
html_show_sphinx = True
Expand Down
2 changes: 1 addition & 1 deletion docs/devs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
```{include} ../../../CHANGELOG.md
```{include} ../../CHANGELOG.md
```
2 changes: 1 addition & 1 deletion docs/modules/table.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ def my_table():
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.hed(64, "https://github.com/mdsanima-dev/mdsanima-dev/".center(63), 33)
t.bot(64)
```

Expand Down
10 changes: 5 additions & 5 deletions docs/shell/converts.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ the same value on calling selected convert method for the appropriate option,
both shell command line script and python module.
- Python Function
{bdg-link-primary-line}`frames_to_timecode <../modules/converts.html#function-frames-to-timecode>`
→ Console Script
{bdg-link-primary-line}`frames_to_timecode
</modules/converts/#function-frames-to-timecode>` → Console Script
{bdg-link-secondary-line}`frames-to-timecode <#converts-frames-to-timecode>`
- Python Function
{bdg-link-primary-line}`timecode_to_frames <../modules/converts.html#function-timecode-to-frames>`
→ Console Script
{bdg-link-primary-line}`timecode_to_frames
</modules/converts/#function-timecode-to-frames>` → Console Script
{bdg-link-secondary-line}`timecode-to-frames <#converts-timecode-to-frames>`
```

## Command {bdg-secondary-line}`mdsanima-dev-converts`
## Command {bdg-warning-line}`mdsanima-dev-converts`

Choose converts options which you want to use.

Expand Down
4 changes: 2 additions & 2 deletions src/mdsanima_dev/colors.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ def get_color(text: str = "mdsanima", color: int = 255) -> str:
print(mds_a, mds_b)
Also you can use
:bdg-link-primary-line:`machine <../modules/tools.html#function-machine>`
function:
:bdg-link-primary-line:`machine
</modules/tools/#function-machine>` function:
.. code:: python
Expand Down
15 changes: 8 additions & 7 deletions src/mdsanima_dev/emoji.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
store all emoji data inside `.josn` file on this python package as dictionary.
.. important:: This module only get data from
`Full Emoji List <https://unicode.org/emoji/charts/full-emoji-list.html>`_
and
`Full Emoji Modifiers <https://unicode.org/emoji/charts/full-emoji-modifiers.html>`_
links.
`Full Emoji List
<https://unicode.org/emoji/charts/full-emoji-list.html>`_ and
`Full Emoji Modifiers
<https://unicode.org/emoji/charts/full-emoji-modifiers.html>`_ links.
"""


Expand All @@ -34,7 +34,8 @@ def emoji_get_url_data(emoji_url: str) -> str:
If status ok returning data text for further processing.
.. warning:: This function only used for request data in function
:bdg-link-primary-line:`emoji_clean_url_data <#function-emoji-clean-url-data>`
:bdg-link-primary-line:`emoji_clean_url_data
<#function-emoji-clean-url-data>`
:param emoji_url: Link to emoticons.
:type emoji_url: str
Expand Down Expand Up @@ -292,8 +293,8 @@ def emoji_clean_url_data(

def emoji_load_json_data() -> dict:
"""This function loading the json data generated on previous
:bdg-link-primary-line:`emoji_clean_url_data <#function-emoji-clean-url-data>`
function.
:bdg-link-primary-line:`emoji_clean_url_data
<#function-emoji-clean-url-data>` function.
:return: Dictionary json on all emoji with joining two json `emoji_list`
and `emoji_modifiers`.
Expand Down
18 changes: 12 additions & 6 deletions src/mdsanima_dev/utils/converts.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ def frames_to_timecode(frames: int, fps: float) -> str:
mdsanima-dev-converts frames-to-timecode --help
.. seealso:: Shell console script
:bdg-link-secondary-line:`frames-to-timecode <../console/shell-converts.html#converts-frames-to-timecode>`
:bdg-link-secondary-line:`frames-to-timecode
</shell/converts/#converts-frames-to-timecode>`
converting directly on the command line.
"""
# assigning a function to a variable setup seconds
Expand Down Expand Up @@ -108,7 +109,8 @@ def timecode_to_frames(timecode: str, fps: float) -> int:
mdsanima-dev-converts timecode-to-frames --help
.. seealso:: Shell console script
:bdg-link-secondary-line:`timecode-to-frames <../console/shell-converts.html#converts-timecode-to-frames>`
:bdg-link-secondary-line:`timecode-to-frames
</shell/converts/#converts-timecode-to-frames>`
converting directly on the command line.
"""
# assigning a function to a variable setup seconds
Expand All @@ -131,7 +133,8 @@ def timecode_to_frames(timecode: str, fps: float) -> int:


def shell_frames_to_timecode(frames: int, fps: float) -> str:
"""Shell console script converting frames number to timecode ``00:00:00:00`` format.
"""Shell console script converting frames number to timecode
``00:00:00:00`` format.
:param --frames: Total frames number.
:type --frames: int
Expand Down Expand Up @@ -160,7 +163,8 @@ def shell_frames_to_timecode(frames: int, fps: float) -> str:
print(timecode)
.. seealso:: Invoke function
:bdg-link-primary-line:`frames_to_timecode <../modules/converts.html#function-frames-to-timecode>`
:bdg-link-primary-line:`frames_to_timecode
</modules/converts/#function-frames-to-timecode>`
with a given arguments values.
"""
# run calculation
Expand All @@ -169,7 +173,8 @@ def shell_frames_to_timecode(frames: int, fps: float) -> str:


def shell_timecode_to_frames(timecode: str, fps: float) -> str:
"""Shell console script converting timecode ``00:00:00:00`` format to frames number.
"""Shell console script converting timecode ``00:00:00:00`` format
to frames number.
:param --timecode: Timecode format.
:type --timecode: str
Expand Down Expand Up @@ -198,7 +203,8 @@ def shell_timecode_to_frames(timecode: str, fps: float) -> str:
print(frames)
.. seealso:: Invoke function
:bdg-link-primary-line:`timecode_to_frames <../modules/converts.html#function-timecode-to-frames>`
:bdg-link-primary-line:`timecode_to_frames
</modules/converts/#function-timecode-to-frames>`
with a given arguments values.
"""
# run calculation
Expand Down

0 comments on commit 91b25e8

Please sign in to comment.