Skip to content

Commit 2b6eced

Browse files
committed
Fix formatting in the shortcodes module
1 parent 04379a2 commit 2b6eced

1 file changed

Lines changed: 6 additions & 26 deletions

File tree

docs/overrides/hooks/shortcodes.py

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ============================================================================ #
22
# #
3-
# Title: Title #
4-
# Purpose: Purpose #
3+
# Title: Shortcodes and Hooks for MkDocs Material Documentation #
4+
# Purpose: Provide custom shortcodes and hooks for enhancing the docs. #
55
# Notes: Created with reference to MkDocs Material hooks and shortcodes. #
66
# https://github.com/squidfunk/mkdocs-material/blob/master/src/overrides/hooks/shortcodes.py
77
# #
@@ -33,36 +33,16 @@
3333
from mkdocs.structure.files import File, Files
3434
from mkdocs.structure.pages import Page
3535

36+
# ## Local First Party Imports ----
37+
from toolbox_python.types import str_list
3638

37-
## --------------------------------------------------------------------------- #
38-
## Exports ####
39-
## --------------------------------------------------------------------------- #
40-
41-
42-
__all__: str_list = [...]
4339

44-
45-
## --------------------------------------------------------------------------- #
46-
## Constants ####
4740
## --------------------------------------------------------------------------- #
48-
49-
50-
CONSTANT = ...
51-
52-
53-
## --------------------------------------------------------------------------- #
54-
## Types ####
41+
## Exports ####
5542
## --------------------------------------------------------------------------- #
5643

5744

58-
TYPE = ...
59-
60-
61-
# ---------------------------------------------------------------------------- #
62-
# #
63-
# Hooks ####
64-
# #
65-
# ---------------------------------------------------------------------------- #
45+
__all__: str_list = ["on_page_markdown", "flag", "option", "setting"]
6646

6747

6848
## --------------------------------------------------------------------------- #

0 commit comments

Comments
 (0)