mkdocs-mknodes 0.6.2__tar.gz → 0.7.3__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/.editorconfig +11 -11
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/.github/README.md +215 -215
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/.github/copilot-instructions.md +20 -20
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/.github/dependabot.yml +10 -10
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/.github/workflows/build.yml +85 -85
- mkdocs_mknodes-0.7.3/.github/workflows/documentation.yml +68 -0
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/.gitignore +54 -54
- mkdocs_mknodes-0.7.3/.logfire/.gitignore +1 -0
- mkdocs_mknodes-0.7.3/.logfire/logfire_credentials.json +6 -0
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/.pre-commit-config.yaml +49 -49
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/LICENSE +22 -22
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/PKG-INFO +4 -2
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/README.md +58 -58
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/configs/mkdocs_mkdocs.yml +62 -62
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/configs/mkdocs_shared.yml +32 -32
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/docs/build_process.jinja +35 -35
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/docs/cli_index.jinja +18 -18
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/docs/github_index.jinja +13 -13
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/docs/index.jinja +28 -28
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/docs/plugin_configuration.jinja +2 -2
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/docs/use_case_by_config.jinja +19 -19
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/docs/use_case_default_website.jinja +18 -18
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/docs/use_cases_index.jinja +45 -45
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/docs/why_should_i_use_mknodes.jinja +44 -44
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/duties.py +68 -68
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs.yml +105 -105
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/__init__.py +17 -17
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/appconfig/appconfig.py +826 -834
- mkdocs_mknodes-0.7.3/mkdocs_mknodes/appconfig/base.py +64 -0
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/appconfig/jinjaconfig.py +60 -60
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/appconfig/themeconfig.py +179 -179
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/appconfig/upathtype.py +178 -178
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/appconfig/validationconfig.py +41 -41
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/backends/__init__.py +1 -1
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/backends/buildbackend.py +50 -50
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/backends/markdownbackend.py +43 -43
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/backends/mkdocsbackend.py +162 -162
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/buildcollector.py +301 -301
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/buildcontext.py +43 -43
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/builders/configbuilder.py +56 -57
- mkdocs_mknodes-0.7.3/mkdocs_mknodes/builders/markdownbuilder.py +247 -0
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/cli/__init__.py +180 -180
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/cli/richstate.py +34 -34
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/commands/build_page.py +420 -367
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/commands/serve.py +187 -183
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/commands/utils.py +213 -213
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/liveserver.py +379 -379
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/manual/__init__.py +1 -1
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/manual/cli_section.py +28 -28
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/manual/get_started_section.py +49 -49
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/manual/github_index.py +17 -17
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/manual/root.py +30 -30
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/manual/use_cases_section.py +19 -19
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/mkdefaultwebsite.py +54 -54
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/mkdocsconfig.py +248 -258
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/paths.py +11 -11
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/plugin/__init__.py +222 -214
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/plugin/mkdocsbuilder.py +141 -136
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/plugin/mkdocshelpers.py +25 -25
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/plugin/mknodesconfig.py +342 -339
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/plugin/pluginconfig.py +144 -143
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/plugin/rewriteloader.py +56 -56
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/resources/timeline_data.toml +135 -135
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/telemetry.py +93 -95
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes.sublime-project +8 -8
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/overrides/_dummy.txt +1 -1
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/overrides/partials/actions.html +65 -65
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/pyproject.toml +265 -264
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/tests/conftest.py +10 -10
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/tests/test_build.py +60 -60
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/tests/test_cli.py +67 -67
- mkdocs_mknodes-0.6.2/.github/workflows/documentation.yml +0 -68
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/docs/assets/cli.gif +0 -0
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/appconfig/__init__.py +0 -0
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/builders/__init__.py +0 -0
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/commands/__init__.py +0 -0
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/py.typed +0 -0
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/tests/__init__.py +0 -0
- {mkdocs_mknodes-0.6.2 → mkdocs_mknodes-0.7.3}/tests/data/objects.inv +0 -0
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# http://editorconfig.org
|
|
2
|
-
|
|
3
|
-
root = true
|
|
4
|
-
|
|
5
|
-
[*]
|
|
6
|
-
indent_style = space
|
|
7
|
-
indent_size = 4
|
|
8
|
-
trim_trailing_whitespace = true
|
|
9
|
-
insert_final_newline = true
|
|
10
|
-
charset = utf-8
|
|
11
|
-
end_of_line = lf
|
|
1
|
+
# http://editorconfig.org
|
|
2
|
+
|
|
3
|
+
root = true
|
|
4
|
+
|
|
5
|
+
[*]
|
|
6
|
+
indent_style = space
|
|
7
|
+
indent_size = 4
|
|
8
|
+
trim_trailing_whitespace = true
|
|
9
|
+
insert_final_newline = true
|
|
10
|
+
charset = utf-8
|
|
11
|
+
end_of_line = lf
|
|
@@ -1,215 +1,215 @@
|
|
|
1
|
-
``` py title='__main__.create_github_index_md' linenums="86" hl_lines="3"
|
|
2
|
-
def create_github_index_md() -> mk.MkPage:
|
|
3
|
-
page = mk.MkPage("Github index")
|
|
4
|
-
page += mk.MkCode.for_object(create_github_index_md)
|
|
5
|
-
page += mk.MkHeader("MkNodes", level=1)
|
|
6
|
-
page += mk.MkHeader("Don't write docs. Code them.", level=4)
|
|
7
|
-
page += mk.MkShields()
|
|
8
|
-
page += mk.MkLink(DOC_URL, "Read the completely coded documentation!")
|
|
9
|
-
page += mk.MkInstallGuide(header="How to install")
|
|
10
|
-
page += mk.MkHeader("All the nodes!")
|
|
11
|
-
page += mk.MkClassDiagram(mk.MkNode, mode="subclasses", direction="LR")
|
|
12
|
-
return page
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
# MkNodes (Mkdocs Plugin)
|
|
16
|
-
|
|
17
|
-
#### Don't write docs. Code them.
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
21
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
22
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
23
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
24
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
25
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
26
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
27
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
28
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
29
|
-
[](https://github.com/phil65/mkdocs_mknodes/releases)
|
|
30
|
-
[](https://github.com/phil65/mkdocs_mknodes/graphs/contributors)
|
|
31
|
-
[](https://github.com/phil65/mkdocs_mknodes/discussions)
|
|
32
|
-
[](https://github.com/phil65/mkdocs_mknodes/forks)
|
|
33
|
-
[](https://github.com/phil65/mkdocs_mknodes/issues)
|
|
34
|
-
[](https://github.com/phil65/mkdocs_mknodes/pulls)
|
|
35
|
-
[](https://github.com/phil65/mkdocs_mknodes/watchers)
|
|
36
|
-
[](https://github.com/phil65/mkdocs_mknodes/stars)
|
|
37
|
-
[](https://github.com/phil65/mkdocs_mknodes)
|
|
38
|
-
[](https://github.com/phil65/mkdocs_mknodes/commits)
|
|
39
|
-
[](https://github.com/phil65/mkdocs_mknodes/releases)
|
|
40
|
-
[](https://github.com/phil65/mkdocs_mknodes)
|
|
41
|
-
[](https://github.com/phil65/mkdocs_mknodes)
|
|
42
|
-
[](https://github.com/phil65/mkdocs_mknodes)
|
|
43
|
-
[](https://github.com/phil65/mkdocs_mknodes)
|
|
44
|
-
[](https://codecov.io/gh/phil65/mkdocs_mknodes/)
|
|
45
|
-
[](https://github.com/psf/black)
|
|
46
|
-
[](https://pyup.io/repos/github/phil65/mkdocs_mknodes/)
|
|
47
|
-
|
|
48
|
-
[Read the completely coded documentation!](https://phil65.github.io/mkdocs-mknodes/)
|
|
49
|
-
|
|
50
|
-
## How to install
|
|
51
|
-
|
|
52
|
-
### pip
|
|
53
|
-
|
|
54
|
-
The latest released version is available at the [Python package index](https://pypi.org/project/mknodes).
|
|
55
|
-
|
|
56
|
-
``` py
|
|
57
|
-
pip install mkdocs-mknodes
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
## All the nodes!
|
|
61
|
-
|
|
62
|
-
``` mermaid
|
|
63
|
-
graph LR
|
|
64
|
-
2257944740368["mknode.MkNode"]
|
|
65
|
-
2257944738416["mkheader.MkHeader"]
|
|
66
|
-
2257955065920["mktext.MkText"]
|
|
67
|
-
2257991175136["mkchangelog.MkChangelog"]
|
|
68
|
-
2257991176112["mkcodeofconduct.MkCodeOfConduct"]
|
|
69
|
-
2257952121424["mklicense.MkLicense"]
|
|
70
|
-
2257955088368["mkcontainer.MkContainer"]
|
|
71
|
-
2257955064944["mkblock.MkBlock"]
|
|
72
|
-
2257955089344["mkhtmlblock.MkHtmlBlock"]
|
|
73
|
-
2257955078608["mkadmonitionblock.MkAdmonitionBlock"]
|
|
74
|
-
2257955077632["mkdetailsblock.MkDetailsBlock"]
|
|
75
|
-
2257955160592["mktabs.MkTabBlock"]
|
|
76
|
-
2257955071776["mkadmonition.MkAdmonition"]
|
|
77
|
-
2257955084464["mkblockquote.MkBlockQuote"]
|
|
78
|
-
2257955086416["mkcode.MkCode"]
|
|
79
|
-
2257955158640["mkdiagram.MkDiagram"]
|
|
80
|
-
2257954958560["mkclassdiagram.MkClassDiagram"]
|
|
81
|
-
2257952071648["mktreeview.MkTreeView"]
|
|
82
|
-
2257952109712["mkmoduleoverview.MkModuleOverview"]
|
|
83
|
-
2257952072624["mkprettyprint.MkPrettyPrint"]
|
|
84
|
-
2257952105808["mklog.MkLog"]
|
|
85
|
-
2257955091296["mkfootnotes.MkFootNote"]
|
|
86
|
-
2257955082512["mkfootnotes.MkFootNotes"]
|
|
87
|
-
2257955101056["mkpage.MkPage"]
|
|
88
|
-
2257954988816["mktemplatepage.MkTemplatePage"]
|
|
89
|
-
2257954999552["mkclasspage.MkClassPage"]
|
|
90
|
-
2257954994672["mkmodulepage.MkModulePage"]
|
|
91
|
-
2257955157664["mkgrid.MkGridCard"]
|
|
92
|
-
2257955147904["mkgrid.MkGrid"]
|
|
93
|
-
2257955154736["mklist.MkList"]
|
|
94
|
-
2257955175232["mkbasetable.MkBaseTable"]
|
|
95
|
-
2257955144976["mktable.MkTable"]
|
|
96
|
-
2257954973200["mkclasstable.MkClassTable"]
|
|
97
|
-
2257954940992["mkmoduletable.MkModuleTable"]
|
|
98
|
-
2257952107760["mkdependencytable.MkDependencyTable"]
|
|
99
|
-
2257955159616["mkhtmltable.MkHtmlTable"]
|
|
100
|
-
2257955161568["mktabs.MkTab"]
|
|
101
|
-
2257955162544["mktabcontainer.MkTabContainer"]
|
|
102
|
-
2257955163520["mktabcontainer.MkTabbed"]
|
|
103
|
-
2257952104832["mkreprrawrendered.MkReprRawRendered"]
|
|
104
|
-
2257955164496["mktabcontainer.MkTabbedBlocks"]
|
|
105
|
-
2257955171328["mkcritic.MkCritic"]
|
|
106
|
-
2257955166448["mkannotations.MkAnnotation"]
|
|
107
|
-
2257955168400["mkannotations.MkAnnotations"]
|
|
108
|
-
2257955172304["mkdefinitionlist.MkDefinition"]
|
|
109
|
-
2257952113616["mkconfigsetting.MkConfigSetting"]
|
|
110
|
-
2257955173280["mkdefinitionlist.MkDefinitionList"]
|
|
111
|
-
2257954969296["mkshowcase.MkShowcase"]
|
|
112
|
-
2257954957584["mkspeechbubble.MkSpeechBubble"]
|
|
113
|
-
2257954949776["mktasklist.MkTask"]
|
|
114
|
-
2257954941968["mktasklist.MkTaskList"]
|
|
115
|
-
2257954944896["mkmetadatabadges.MkMetadataBadges"]
|
|
116
|
-
2257954981984["mkshields.MkShields"]
|
|
117
|
-
2257954992720["mkinstallguide.MkInstallGuide"]
|
|
118
|
-
2257991178064["mkcommitconventions.MkCommitConventions"]
|
|
119
|
-
2257991156592["mkpullrequestguidelines.MkPullRequestGuidelines"]
|
|
120
|
-
2257952053104["mkdevenvsetup.MkDevEnvSetup"]
|
|
121
|
-
2257952110688["mkcommentedcode.MkCommentedCode"]
|
|
122
|
-
2257952114592["mkpluginflow.MkPluginFlow"]
|
|
123
|
-
2257952116544["mkargparsehelp.MkArgParseHelp"]
|
|
124
|
-
2257955097152["mknav.MkNav"]
|
|
125
|
-
2257954996624["mkdoc.MkDoc"]
|
|
126
|
-
2257994953952["mkblog.MkBlog"]
|
|
127
|
-
2257955149856["mklink.MkLink"]
|
|
128
|
-
2257955129360["mkkeys.MkKeys"]
|
|
129
|
-
2257955139120["_mkdocstrings.MkDocStrings"]
|
|
130
|
-
2257955131312["mkimage.MkImage"]
|
|
131
|
-
2257955150832["mkbinaryimage.MkBinaryImage"]
|
|
132
|
-
2257954964416["mkbadge.MkBadge"]
|
|
133
|
-
2257955165472["mksnippet.MkSnippet"]
|
|
134
|
-
2257955169376["mkiframe.MkIFrame"]
|
|
135
|
-
2257955170352["mkprogressbar.MkProgressBar"]
|
|
136
|
-
2257954960512["mkcard.MkCard"]
|
|
137
|
-
2257954976128["mkinclude.MkInclude"]
|
|
138
|
-
2257952108736["mkcommandoutput.MkCommandOutput"]
|
|
139
|
-
2257952117520["mkjinjatemplate.MkTemplate"]
|
|
140
|
-
2257944740368 --> 2257944738416
|
|
141
|
-
2257944740368 --> 2257955065920
|
|
142
|
-
2257955065920 --> 2257991175136
|
|
143
|
-
2257955065920 --> 2257991176112
|
|
144
|
-
2257955065920 --> 2257952121424
|
|
145
|
-
2257944740368 --> 2257955088368
|
|
146
|
-
2257955088368 --> 2257955064944
|
|
147
|
-
2257955064944 --> 2257955089344
|
|
148
|
-
2257955064944 --> 2257955078608
|
|
149
|
-
2257955064944 --> 2257955077632
|
|
150
|
-
2257955064944 --> 2257955160592
|
|
151
|
-
2257955088368 --> 2257955071776
|
|
152
|
-
2257955088368 --> 2257955084464
|
|
153
|
-
2257955088368 --> 2257955086416
|
|
154
|
-
2257955086416 --> 2257955158640
|
|
155
|
-
2257955158640 --> 2257954958560
|
|
156
|
-
2257955086416 --> 2257952071648
|
|
157
|
-
2257952071648 --> 2257952109712
|
|
158
|
-
2257955086416 --> 2257952072624
|
|
159
|
-
2257955086416 --> 2257952105808
|
|
160
|
-
2257955088368 --> 2257955091296
|
|
161
|
-
2257955088368 --> 2257955082512
|
|
162
|
-
2257955088368 --> 2257955101056
|
|
163
|
-
2257955101056 --> 2257954988816
|
|
164
|
-
2257954988816 --> 2257954999552
|
|
165
|
-
2257954988816 --> 2257954994672
|
|
166
|
-
2257955088368 --> 2257955157664
|
|
167
|
-
2257955088368 --> 2257955147904
|
|
168
|
-
2257955088368 --> 2257955154736
|
|
169
|
-
2257955088368 --> 2257955175232
|
|
170
|
-
2257955175232 --> 2257955144976
|
|
171
|
-
2257955144976 --> 2257954973200
|
|
172
|
-
2257955144976 --> 2257954940992
|
|
173
|
-
2257955144976 --> 2257952107760
|
|
174
|
-
2257955175232 --> 2257955159616
|
|
175
|
-
2257955088368 --> 2257955161568
|
|
176
|
-
2257955088368 --> 2257955162544
|
|
177
|
-
2257955162544 --> 2257955163520
|
|
178
|
-
2257955163520 --> 2257952104832
|
|
179
|
-
2257955162544 --> 2257955164496
|
|
180
|
-
2257955088368 --> 2257955171328
|
|
181
|
-
2257955088368 --> 2257955166448
|
|
182
|
-
2257955088368 --> 2257955168400
|
|
183
|
-
2257955088368 --> 2257955172304
|
|
184
|
-
2257955172304 --> 2257952113616
|
|
185
|
-
2257955088368 --> 2257955173280
|
|
186
|
-
2257955088368 --> 2257954969296
|
|
187
|
-
2257955088368 --> 2257954957584
|
|
188
|
-
2257955088368 --> 2257954949776
|
|
189
|
-
2257955088368 --> 2257954941968
|
|
190
|
-
2257955088368 --> 2257954944896
|
|
191
|
-
2257955088368 --> 2257954981984
|
|
192
|
-
2257955088368 --> 2257954992720
|
|
193
|
-
2257955088368 --> 2257991178064
|
|
194
|
-
2257955088368 --> 2257991156592
|
|
195
|
-
2257955088368 --> 2257952053104
|
|
196
|
-
2257955088368 --> 2257952110688
|
|
197
|
-
2257955088368 --> 2257952114592
|
|
198
|
-
2257955088368 --> 2257952116544
|
|
199
|
-
2257944740368 --> 2257955097152
|
|
200
|
-
2257955097152 --> 2257954996624
|
|
201
|
-
2257955097152 --> 2257994953952
|
|
202
|
-
2257944740368 --> 2257955149856
|
|
203
|
-
2257944740368 --> 2257955129360
|
|
204
|
-
2257944740368 --> 2257955139120
|
|
205
|
-
2257944740368 --> 2257955131312
|
|
206
|
-
2257955131312 --> 2257955150832
|
|
207
|
-
2257955131312 --> 2257954964416
|
|
208
|
-
2257944740368 --> 2257955165472
|
|
209
|
-
2257944740368 --> 2257955169376
|
|
210
|
-
2257944740368 --> 2257955170352
|
|
211
|
-
2257944740368 --> 2257954960512
|
|
212
|
-
2257944740368 --> 2257954976128
|
|
213
|
-
2257944740368 --> 2257952108736
|
|
214
|
-
2257944740368 --> 2257952117520
|
|
215
|
-
```
|
|
1
|
+
``` py title='__main__.create_github_index_md' linenums="86" hl_lines="3"
|
|
2
|
+
def create_github_index_md() -> mk.MkPage:
|
|
3
|
+
page = mk.MkPage("Github index")
|
|
4
|
+
page += mk.MkCode.for_object(create_github_index_md)
|
|
5
|
+
page += mk.MkHeader("MkNodes", level=1)
|
|
6
|
+
page += mk.MkHeader("Don't write docs. Code them.", level=4)
|
|
7
|
+
page += mk.MkShields()
|
|
8
|
+
page += mk.MkLink(DOC_URL, "Read the completely coded documentation!")
|
|
9
|
+
page += mk.MkInstallGuide(header="How to install")
|
|
10
|
+
page += mk.MkHeader("All the nodes!")
|
|
11
|
+
page += mk.MkClassDiagram(mk.MkNode, mode="subclasses", direction="LR")
|
|
12
|
+
return page
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
# MkNodes (Mkdocs Plugin)
|
|
16
|
+
|
|
17
|
+
#### Don't write docs. Code them.
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
21
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
22
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
23
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
24
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
25
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
26
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
27
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
28
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
29
|
+
[](https://github.com/phil65/mkdocs_mknodes/releases)
|
|
30
|
+
[](https://github.com/phil65/mkdocs_mknodes/graphs/contributors)
|
|
31
|
+
[](https://github.com/phil65/mkdocs_mknodes/discussions)
|
|
32
|
+
[](https://github.com/phil65/mkdocs_mknodes/forks)
|
|
33
|
+
[](https://github.com/phil65/mkdocs_mknodes/issues)
|
|
34
|
+
[](https://github.com/phil65/mkdocs_mknodes/pulls)
|
|
35
|
+
[](https://github.com/phil65/mkdocs_mknodes/watchers)
|
|
36
|
+
[](https://github.com/phil65/mkdocs_mknodes/stars)
|
|
37
|
+
[](https://github.com/phil65/mkdocs_mknodes)
|
|
38
|
+
[](https://github.com/phil65/mkdocs_mknodes/commits)
|
|
39
|
+
[](https://github.com/phil65/mkdocs_mknodes/releases)
|
|
40
|
+
[](https://github.com/phil65/mkdocs_mknodes)
|
|
41
|
+
[](https://github.com/phil65/mkdocs_mknodes)
|
|
42
|
+
[](https://github.com/phil65/mkdocs_mknodes)
|
|
43
|
+
[](https://github.com/phil65/mkdocs_mknodes)
|
|
44
|
+
[](https://codecov.io/gh/phil65/mkdocs_mknodes/)
|
|
45
|
+
[](https://github.com/psf/black)
|
|
46
|
+
[](https://pyup.io/repos/github/phil65/mkdocs_mknodes/)
|
|
47
|
+
|
|
48
|
+
[Read the completely coded documentation!](https://phil65.github.io/mkdocs-mknodes/)
|
|
49
|
+
|
|
50
|
+
## How to install
|
|
51
|
+
|
|
52
|
+
### pip
|
|
53
|
+
|
|
54
|
+
The latest released version is available at the [Python package index](https://pypi.org/project/mknodes).
|
|
55
|
+
|
|
56
|
+
``` py
|
|
57
|
+
pip install mkdocs-mknodes
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## All the nodes!
|
|
61
|
+
|
|
62
|
+
``` mermaid
|
|
63
|
+
graph LR
|
|
64
|
+
2257944740368["mknode.MkNode"]
|
|
65
|
+
2257944738416["mkheader.MkHeader"]
|
|
66
|
+
2257955065920["mktext.MkText"]
|
|
67
|
+
2257991175136["mkchangelog.MkChangelog"]
|
|
68
|
+
2257991176112["mkcodeofconduct.MkCodeOfConduct"]
|
|
69
|
+
2257952121424["mklicense.MkLicense"]
|
|
70
|
+
2257955088368["mkcontainer.MkContainer"]
|
|
71
|
+
2257955064944["mkblock.MkBlock"]
|
|
72
|
+
2257955089344["mkhtmlblock.MkHtmlBlock"]
|
|
73
|
+
2257955078608["mkadmonitionblock.MkAdmonitionBlock"]
|
|
74
|
+
2257955077632["mkdetailsblock.MkDetailsBlock"]
|
|
75
|
+
2257955160592["mktabs.MkTabBlock"]
|
|
76
|
+
2257955071776["mkadmonition.MkAdmonition"]
|
|
77
|
+
2257955084464["mkblockquote.MkBlockQuote"]
|
|
78
|
+
2257955086416["mkcode.MkCode"]
|
|
79
|
+
2257955158640["mkdiagram.MkDiagram"]
|
|
80
|
+
2257954958560["mkclassdiagram.MkClassDiagram"]
|
|
81
|
+
2257952071648["mktreeview.MkTreeView"]
|
|
82
|
+
2257952109712["mkmoduleoverview.MkModuleOverview"]
|
|
83
|
+
2257952072624["mkprettyprint.MkPrettyPrint"]
|
|
84
|
+
2257952105808["mklog.MkLog"]
|
|
85
|
+
2257955091296["mkfootnotes.MkFootNote"]
|
|
86
|
+
2257955082512["mkfootnotes.MkFootNotes"]
|
|
87
|
+
2257955101056["mkpage.MkPage"]
|
|
88
|
+
2257954988816["mktemplatepage.MkTemplatePage"]
|
|
89
|
+
2257954999552["mkclasspage.MkClassPage"]
|
|
90
|
+
2257954994672["mkmodulepage.MkModulePage"]
|
|
91
|
+
2257955157664["mkgrid.MkGridCard"]
|
|
92
|
+
2257955147904["mkgrid.MkGrid"]
|
|
93
|
+
2257955154736["mklist.MkList"]
|
|
94
|
+
2257955175232["mkbasetable.MkBaseTable"]
|
|
95
|
+
2257955144976["mktable.MkTable"]
|
|
96
|
+
2257954973200["mkclasstable.MkClassTable"]
|
|
97
|
+
2257954940992["mkmoduletable.MkModuleTable"]
|
|
98
|
+
2257952107760["mkdependencytable.MkDependencyTable"]
|
|
99
|
+
2257955159616["mkhtmltable.MkHtmlTable"]
|
|
100
|
+
2257955161568["mktabs.MkTab"]
|
|
101
|
+
2257955162544["mktabcontainer.MkTabContainer"]
|
|
102
|
+
2257955163520["mktabcontainer.MkTabbed"]
|
|
103
|
+
2257952104832["mkreprrawrendered.MkReprRawRendered"]
|
|
104
|
+
2257955164496["mktabcontainer.MkTabbedBlocks"]
|
|
105
|
+
2257955171328["mkcritic.MkCritic"]
|
|
106
|
+
2257955166448["mkannotations.MkAnnotation"]
|
|
107
|
+
2257955168400["mkannotations.MkAnnotations"]
|
|
108
|
+
2257955172304["mkdefinitionlist.MkDefinition"]
|
|
109
|
+
2257952113616["mkconfigsetting.MkConfigSetting"]
|
|
110
|
+
2257955173280["mkdefinitionlist.MkDefinitionList"]
|
|
111
|
+
2257954969296["mkshowcase.MkShowcase"]
|
|
112
|
+
2257954957584["mkspeechbubble.MkSpeechBubble"]
|
|
113
|
+
2257954949776["mktasklist.MkTask"]
|
|
114
|
+
2257954941968["mktasklist.MkTaskList"]
|
|
115
|
+
2257954944896["mkmetadatabadges.MkMetadataBadges"]
|
|
116
|
+
2257954981984["mkshields.MkShields"]
|
|
117
|
+
2257954992720["mkinstallguide.MkInstallGuide"]
|
|
118
|
+
2257991178064["mkcommitconventions.MkCommitConventions"]
|
|
119
|
+
2257991156592["mkpullrequestguidelines.MkPullRequestGuidelines"]
|
|
120
|
+
2257952053104["mkdevenvsetup.MkDevEnvSetup"]
|
|
121
|
+
2257952110688["mkcommentedcode.MkCommentedCode"]
|
|
122
|
+
2257952114592["mkpluginflow.MkPluginFlow"]
|
|
123
|
+
2257952116544["mkargparsehelp.MkArgParseHelp"]
|
|
124
|
+
2257955097152["mknav.MkNav"]
|
|
125
|
+
2257954996624["mkdoc.MkDoc"]
|
|
126
|
+
2257994953952["mkblog.MkBlog"]
|
|
127
|
+
2257955149856["mklink.MkLink"]
|
|
128
|
+
2257955129360["mkkeys.MkKeys"]
|
|
129
|
+
2257955139120["_mkdocstrings.MkDocStrings"]
|
|
130
|
+
2257955131312["mkimage.MkImage"]
|
|
131
|
+
2257955150832["mkbinaryimage.MkBinaryImage"]
|
|
132
|
+
2257954964416["mkbadge.MkBadge"]
|
|
133
|
+
2257955165472["mksnippet.MkSnippet"]
|
|
134
|
+
2257955169376["mkiframe.MkIFrame"]
|
|
135
|
+
2257955170352["mkprogressbar.MkProgressBar"]
|
|
136
|
+
2257954960512["mkcard.MkCard"]
|
|
137
|
+
2257954976128["mkinclude.MkInclude"]
|
|
138
|
+
2257952108736["mkcommandoutput.MkCommandOutput"]
|
|
139
|
+
2257952117520["mkjinjatemplate.MkTemplate"]
|
|
140
|
+
2257944740368 --> 2257944738416
|
|
141
|
+
2257944740368 --> 2257955065920
|
|
142
|
+
2257955065920 --> 2257991175136
|
|
143
|
+
2257955065920 --> 2257991176112
|
|
144
|
+
2257955065920 --> 2257952121424
|
|
145
|
+
2257944740368 --> 2257955088368
|
|
146
|
+
2257955088368 --> 2257955064944
|
|
147
|
+
2257955064944 --> 2257955089344
|
|
148
|
+
2257955064944 --> 2257955078608
|
|
149
|
+
2257955064944 --> 2257955077632
|
|
150
|
+
2257955064944 --> 2257955160592
|
|
151
|
+
2257955088368 --> 2257955071776
|
|
152
|
+
2257955088368 --> 2257955084464
|
|
153
|
+
2257955088368 --> 2257955086416
|
|
154
|
+
2257955086416 --> 2257955158640
|
|
155
|
+
2257955158640 --> 2257954958560
|
|
156
|
+
2257955086416 --> 2257952071648
|
|
157
|
+
2257952071648 --> 2257952109712
|
|
158
|
+
2257955086416 --> 2257952072624
|
|
159
|
+
2257955086416 --> 2257952105808
|
|
160
|
+
2257955088368 --> 2257955091296
|
|
161
|
+
2257955088368 --> 2257955082512
|
|
162
|
+
2257955088368 --> 2257955101056
|
|
163
|
+
2257955101056 --> 2257954988816
|
|
164
|
+
2257954988816 --> 2257954999552
|
|
165
|
+
2257954988816 --> 2257954994672
|
|
166
|
+
2257955088368 --> 2257955157664
|
|
167
|
+
2257955088368 --> 2257955147904
|
|
168
|
+
2257955088368 --> 2257955154736
|
|
169
|
+
2257955088368 --> 2257955175232
|
|
170
|
+
2257955175232 --> 2257955144976
|
|
171
|
+
2257955144976 --> 2257954973200
|
|
172
|
+
2257955144976 --> 2257954940992
|
|
173
|
+
2257955144976 --> 2257952107760
|
|
174
|
+
2257955175232 --> 2257955159616
|
|
175
|
+
2257955088368 --> 2257955161568
|
|
176
|
+
2257955088368 --> 2257955162544
|
|
177
|
+
2257955162544 --> 2257955163520
|
|
178
|
+
2257955163520 --> 2257952104832
|
|
179
|
+
2257955162544 --> 2257955164496
|
|
180
|
+
2257955088368 --> 2257955171328
|
|
181
|
+
2257955088368 --> 2257955166448
|
|
182
|
+
2257955088368 --> 2257955168400
|
|
183
|
+
2257955088368 --> 2257955172304
|
|
184
|
+
2257955172304 --> 2257952113616
|
|
185
|
+
2257955088368 --> 2257955173280
|
|
186
|
+
2257955088368 --> 2257954969296
|
|
187
|
+
2257955088368 --> 2257954957584
|
|
188
|
+
2257955088368 --> 2257954949776
|
|
189
|
+
2257955088368 --> 2257954941968
|
|
190
|
+
2257955088368 --> 2257954944896
|
|
191
|
+
2257955088368 --> 2257954981984
|
|
192
|
+
2257955088368 --> 2257954992720
|
|
193
|
+
2257955088368 --> 2257991178064
|
|
194
|
+
2257955088368 --> 2257991156592
|
|
195
|
+
2257955088368 --> 2257952053104
|
|
196
|
+
2257955088368 --> 2257952110688
|
|
197
|
+
2257955088368 --> 2257952114592
|
|
198
|
+
2257955088368 --> 2257952116544
|
|
199
|
+
2257944740368 --> 2257955097152
|
|
200
|
+
2257955097152 --> 2257954996624
|
|
201
|
+
2257955097152 --> 2257994953952
|
|
202
|
+
2257944740368 --> 2257955149856
|
|
203
|
+
2257944740368 --> 2257955129360
|
|
204
|
+
2257944740368 --> 2257955139120
|
|
205
|
+
2257944740368 --> 2257955131312
|
|
206
|
+
2257955131312 --> 2257955150832
|
|
207
|
+
2257955131312 --> 2257954964416
|
|
208
|
+
2257944740368 --> 2257955165472
|
|
209
|
+
2257944740368 --> 2257955169376
|
|
210
|
+
2257944740368 --> 2257955170352
|
|
211
|
+
2257944740368 --> 2257954960512
|
|
212
|
+
2257944740368 --> 2257954976128
|
|
213
|
+
2257944740368 --> 2257952108736
|
|
214
|
+
2257944740368 --> 2257952117520
|
|
215
|
+
```
|
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
## Code style
|
|
2
|
-
|
|
3
|
-
You can assume Python 3.12.
|
|
4
|
-
Use newest language features if possible
|
|
5
|
-
Adhere to pep8.
|
|
6
|
-
Consider using pattern matching and walrus operators.
|
|
7
|
-
|
|
8
|
-
## Tests
|
|
9
|
-
|
|
10
|
-
Tests are written using PyTest.
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
## DocStrings
|
|
14
|
-
|
|
15
|
-
DocStrings are written in google-style.
|
|
16
|
-
Dont add the types to the Args section.
|
|
17
|
-
Only add a Return section if a value is returned and the meaning of the returned value
|
|
18
|
-
is not obvious.
|
|
19
|
-
You can use markdown admonitions with python-markdown syntax (!!! info, !!! note, !!! warning)
|
|
20
|
-
You can use markdown tables and markdown lists if neccessary.
|
|
1
|
+
## Code style
|
|
2
|
+
|
|
3
|
+
You can assume Python 3.12.
|
|
4
|
+
Use newest language features if possible
|
|
5
|
+
Adhere to pep8.
|
|
6
|
+
Consider using pattern matching and walrus operators.
|
|
7
|
+
|
|
8
|
+
## Tests
|
|
9
|
+
|
|
10
|
+
Tests are written using PyTest.
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## DocStrings
|
|
14
|
+
|
|
15
|
+
DocStrings are written in google-style.
|
|
16
|
+
Dont add the types to the Args section.
|
|
17
|
+
Only add a Return section if a value is returned and the meaning of the returned value
|
|
18
|
+
is not obvious.
|
|
19
|
+
You can use markdown admonitions with python-markdown syntax (!!! info, !!! note, !!! warning)
|
|
20
|
+
You can use markdown tables and markdown lists if neccessary.
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# Set update schedule for GitHub Actions
|
|
2
|
-
|
|
3
|
-
version: 2
|
|
4
|
-
updates:
|
|
5
|
-
|
|
6
|
-
- package-ecosystem: "github-actions"
|
|
7
|
-
directory: "/"
|
|
8
|
-
schedule:
|
|
9
|
-
# Check for updates to GitHub Actions every week
|
|
10
|
-
interval: "weekly"
|
|
1
|
+
# Set update schedule for GitHub Actions
|
|
2
|
+
|
|
3
|
+
version: 2
|
|
4
|
+
updates:
|
|
5
|
+
|
|
6
|
+
- package-ecosystem: "github-actions"
|
|
7
|
+
directory: "/"
|
|
8
|
+
schedule:
|
|
9
|
+
# Check for updates to GitHub Actions every week
|
|
10
|
+
interval: "weekly"
|