mknodes 1.2.0__tar.gz → 2.0.0__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.
Files changed (286) hide show
  1. {mknodes-1.2.0 → mknodes-2.0.0}/PKG-INFO +3 -1
  2. {mknodes-1.2.0 → mknodes-2.0.0}/pyproject.toml +11 -7
  3. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/__init__.py +7 -3
  4. mknodes-2.0.0/src/mknodes/__main__.py +7 -0
  5. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/_mkdocstrings/__init__.py +3 -3
  6. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkadmonition/__init__.py +3 -2
  7. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkannotations/__init__.py +12 -8
  8. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkbasetable/__init__.py +1 -1
  9. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkblock/__init__.py +5 -5
  10. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkblockquote/__init__.py +2 -2
  11. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkcode/__init__.py +3 -3
  12. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkcompactadmonition/__init__.py +2 -2
  13. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkcontainer/__init__.py +5 -4
  14. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkcritic/__init__.py +3 -2
  15. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkdataclassinfo/__init__.py +1 -1
  16. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkdefinitionlist/__init__.py +5 -5
  17. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkdetailsblock/__init__.py +5 -4
  18. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkdiagram/__init__.py +5 -6
  19. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkfootnotes/__init__.py +6 -4
  20. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkheader/__init__.py +2 -2
  21. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkhtmlblock/__init__.py +5 -4
  22. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkhtmlblock/metadata.toml +1 -2
  23. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkhtmltable/__init__.py +4 -4
  24. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkicon/__init__.py +1 -1
  25. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkimage/__init__.py +8 -9
  26. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkimage/metadata.toml +3 -3
  27. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkjupyterlite/__init__.py +1 -1
  28. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkkeys/__init__.py +1 -1
  29. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mklink/__init__.py +6 -8
  30. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mklink/metadata.toml +2 -2
  31. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mklist/__init__.py +2 -2
  32. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkmaterialbadge/__init__.py +1 -1
  33. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mknode/__init__.py +40 -40
  34. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkprogressbar/__init__.py +1 -1
  35. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkpyodide/__init__.py +1 -1
  36. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkpyscript/__init__.py +1 -1
  37. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkshowcase/__init__.py +3 -2
  38. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkspeechbubble/__init__.py +5 -4
  39. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktabbedblocks/metadata.toml +1 -1
  40. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktabcontainer.py +8 -7
  41. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktable/__init__.py +1 -1
  42. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktabs/__init__.py +5 -4
  43. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktabs/mktab.toml +1 -1
  44. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktasklist/__init__.py +2 -2
  45. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktext/__init__.py +7 -8
  46. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktimeline/__init__.py +8 -13
  47. mknodes-2.0.0/src/mknodes/build/__init__.py +10 -0
  48. mknodes-2.0.0/src/mknodes/build/builder.py +110 -0
  49. mknodes-2.0.0/src/mknodes/build/exporter.py +168 -0
  50. mknodes-2.0.0/src/mknodes/build/output.py +30 -0
  51. mknodes-2.0.0/src/mknodes/cli/__init__.py +164 -0
  52. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/data/badges.py +1 -1
  53. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/data/fences.py +1 -1
  54. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/extranodes/mkcodeimage/__init__.py +1 -1
  55. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/extranodes/mkgrid/__init__.py +4 -4
  56. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/extranodes/mksnippet/__init__.py +1 -1
  57. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/folderinfo.py +4 -3
  58. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/gitrepository.py +7 -14
  59. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/license.py +19 -19
  60. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/linkprovider.py +7 -7
  61. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/nodefile.py +44 -24
  62. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/packageinfo.py +5 -5
  63. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/jinja/filters.py +6 -6
  64. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/jinja/nodeenvironment.py +72 -10
  65. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/manual/a_quick_tour.py +8 -8
  66. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/manual/page_section.py +1 -0
  67. mknodes-2.0.0/src/mknodes/manual/standalone.py +80 -0
  68. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/navs/mkdoc.py +2 -1
  69. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/navs/mknav.py +10 -12
  70. mknodes-2.0.0/src/mknodes/navs/navigation.py +239 -0
  71. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/navs/navparser.py +17 -35
  72. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/navs/navrouter.py +65 -30
  73. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/navs/router.py +2 -2
  74. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/metadata.py +1 -1
  75. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/mkclasspage/__init__.py +7 -2
  76. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/mkpage.py +4 -4
  77. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/mktemplatepage.py +8 -4
  78. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/pagetemplate.py +15 -8
  79. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/templateblocks.py +3 -3
  80. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkbadge/__init__.py +15 -7
  81. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkbadge/metadata.toml +1 -1
  82. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkchangelog/__init__.py +4 -2
  83. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkclassdiagram/__init__.py +2 -3
  84. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkdevtools/__init__.py +4 -8
  85. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkinclude/__init__.py +1 -1
  86. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mklicense/__init__.py +2 -2
  87. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkllm/__init__.py +12 -12
  88. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkllm/metadata.toml +1 -1
  89. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkmetadatabadges/__init__.py +4 -3
  90. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkpipdeptree/__init__.py +8 -27
  91. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkpydeps/__init__.py +19 -15
  92. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkpydeps/metadata.toml +1 -1
  93. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkreprrawrendered/__init__.py +1 -2
  94. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkreprrawrendered/metadata.toml +1 -1
  95. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkshields/__init__.py +3 -2
  96. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mktemplate/__init__.py +9 -4
  97. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mktemplatetable/__init__.py +9 -10
  98. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mktreeview/__init__.py +17 -12
  99. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mktreeview/metadata.toml +5 -5
  100. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/theme/materialtheme/__init__.py +15 -15
  101. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/theme/mkblog.py +2 -2
  102. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/theme/theme.py +5 -5
  103. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/classhelpers.py +1 -1
  104. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/color.py +2 -2
  105. mknodes-2.0.0/src/mknodes/utils/coroutines.py +30 -0
  106. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/helpers.py +2 -2
  107. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/icons.py +4 -8
  108. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/inspecthelpers.py +3 -3
  109. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/inventorymanager.py +3 -8
  110. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/packagehelpers.py +4 -4
  111. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/pathhelpers.py +1 -1
  112. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/reprhelpers.py +1 -1
  113. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/resources.py +22 -18
  114. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/xmlhelpers.py +2 -2
  115. mknodes-1.2.0/mknodes/navs/navigation.py +0 -133
  116. {mknodes-1.2.0 → mknodes-2.0.0}/LICENSE +0 -0
  117. {mknodes-1.2.0 → mknodes-2.0.0}/README.md +0 -0
  118. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/__init__.py +0 -0
  119. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/_mkdocstrings/metadata.toml +0 -0
  120. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkadmonition/metadata.toml +0 -0
  121. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkannotations/metadata.toml +0 -0
  122. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkbinaryimage/__init__.py +0 -0
  123. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkbinaryimage/metadata.toml +0 -0
  124. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkblockquote/metadata.toml +0 -0
  125. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkcard/__init__.py +0 -0
  126. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkcard/grid.css +0 -0
  127. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkcard/metadata.toml +0 -0
  128. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkclidoc/__init__.py +0 -0
  129. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkclidoc/metadata.toml +0 -0
  130. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkcode/metadata.toml +0 -0
  131. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkcompactadmonition/compactadmonition.css +0 -0
  132. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkcompactadmonition/metadata.toml +0 -0
  133. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkcontainer/metadata.toml +0 -0
  134. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkcritic/metadata.toml +0 -0
  135. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkdataclassinfo/metadata.toml +0 -0
  136. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkdefinitionlist/metadata.toml +0 -0
  137. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkdetailsblock/metadata.toml +0 -0
  138. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkdiagram/metadata.toml +0 -0
  139. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkfootnotes/metadata.toml +0 -0
  140. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkheader/metadata.toml +0 -0
  141. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkhtmltable/metadata.toml +0 -0
  142. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkicon/metadata.toml +0 -0
  143. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkiframe/__init__.py +0 -0
  144. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkiframe/metadata.toml +0 -0
  145. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkimagecompare/__init__.py +0 -0
  146. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkimagecompare/metadata.toml +0 -0
  147. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkimageslideshow/__init__.py +0 -0
  148. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkimageslideshow/metadata.toml +0 -0
  149. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkjupyterlite/metadata.toml +0 -0
  150. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkkeys/metadata.toml +0 -0
  151. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mklist/metadata.toml +0 -0
  152. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkmaterialbadge/materialbadge.css +0 -0
  153. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkmaterialbadge/metadata.toml +0 -0
  154. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkprogressbar/metadata.toml +0 -0
  155. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkprogressbar/progressbar.css +0 -0
  156. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkpyodide/metadata.toml +0 -0
  157. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkpyscript/metadata.toml +0 -0
  158. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkshowcase/metadata.toml +0 -0
  159. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkspeechbubble/metadata.toml +0 -0
  160. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mkspeechbubble/speechbubble.css +0 -0
  161. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktabbed/__init__.py +0 -0
  162. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktabbed/metadata.toml +0 -0
  163. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktabbedblocks/__init__.py +0 -0
  164. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktable/metadata.toml +0 -0
  165. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktasklist/metadata.toml +0 -0
  166. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktext/metadata.toml +0 -0
  167. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktimeline/metadata.toml +0 -0
  168. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktimeline/timeline.css +0 -0
  169. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/mktimeline/timeline.js +0 -0
  170. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/basenodes/processors/__init__.py +0 -0
  171. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/data/__init__.py +0 -0
  172. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/data/admonition.py +0 -0
  173. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/data/buildsystems.py +0 -0
  174. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/data/commitconventions.py +0 -0
  175. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/data/datatypes.py +0 -0
  176. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/data/eventplugins.py +0 -0
  177. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/data/installmethods.py +0 -0
  178. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/data/taskrunners.py +0 -0
  179. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/data/tools.py +0 -0
  180. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/data/treestyles.py +0 -0
  181. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/extranodes/__init__.py +0 -0
  182. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/extranodes/mkcodeimage/metadata.toml +0 -0
  183. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/extranodes/mkgrid/metadata.toml +0 -0
  184. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/extranodes/mkprettyprint/__init__.py +0 -0
  185. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/extranodes/mkprettyprint/metadata.toml +0 -0
  186. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/extranodes/mksnippet/metadata.toml +0 -0
  187. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/__init__.py +0 -0
  188. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/configfile.py +0 -0
  189. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/contexts.py +0 -0
  190. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/grifferegistry.py +0 -0
  191. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/mkdocsconfigfile.py +0 -0
  192. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/packageregistry.py +0 -0
  193. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/pyproject.py +0 -0
  194. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/info/reporegistry.py +0 -0
  195. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/jinja/__init__.py +0 -0
  196. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/manual/__init__.py +0 -0
  197. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/manual/dev_section.py +0 -0
  198. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/manual/get_started_section.py +0 -0
  199. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/manual/github_index.py +0 -0
  200. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/manual/navs_section.py +0 -0
  201. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/manual/nodes_section.py +0 -0
  202. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/manual/root.py +0 -0
  203. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/manual/routing.py +0 -0
  204. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/manual/templating_section.py +0 -0
  205. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/mdlib/__init__.py +0 -0
  206. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/mdlib/mdconverter.py +0 -0
  207. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/navs/__init__.py +0 -0
  208. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/navs/navbuilder.py +0 -0
  209. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/nodemods/__init__.py +0 -0
  210. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/nodemods/mod.py +0 -0
  211. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/nodemods/modmanager.py +0 -0
  212. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/nodemods/parallax.py +0 -0
  213. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/nodemods/parallax.toml +0 -0
  214. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/nodemods/scrollreveal.py +0 -0
  215. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/nodemods/scrollreveal.toml +0 -0
  216. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/__init__.py +0 -0
  217. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/mkclasspage/classpage.md +0 -0
  218. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/mkclasspage/classpage_tabbed.md +0 -0
  219. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/mkmodulepage/__init__.py +0 -0
  220. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/mkmodulepage/modulepage.md +0 -0
  221. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/templateregistry.py +0 -0
  222. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/pages/toc.py +0 -0
  223. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/paths.py +0 -0
  224. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/py.typed +0 -0
  225. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/css/animated.css +0 -0
  226. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/css/hero.css +0 -0
  227. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/css/material_css_extra.jinja +0 -0
  228. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/css/theme_material.css +0 -0
  229. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/css/theme_mkdocs.css +0 -0
  230. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/filters.toml +0 -0
  231. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/js/tablesort.js +0 -0
  232. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/python_objects.inv +0 -0
  233. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/toolfiles/tool_black.toml +0 -0
  234. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/toolfiles/tool_coverage.toml +0 -0
  235. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/toolfiles/tool_mkdocs.toml +0 -0
  236. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/toolfiles/tool_mypy.toml +0 -0
  237. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/toolfiles/tool_precommit.toml +0 -0
  238. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/toolfiles/tool_pyright.toml +0 -0
  239. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/resources/toolfiles/tool_ruff.toml +0 -0
  240. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/__init__.py +0 -0
  241. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkchangelog/metadata.toml +0 -0
  242. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkclassdiagram/metadata.toml +0 -0
  243. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkclasstable/__init__.py +0 -0
  244. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkclasstable/metadata.toml +0 -0
  245. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkcodeofconduct/__init__.py +0 -0
  246. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkcodeofconduct/metadata.toml +0 -0
  247. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkcommandoutput/__init__.py +0 -0
  248. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkcommandoutput/metadata.toml +0 -0
  249. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkcommandoutput/terminal.css +0 -0
  250. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkcommentedcode/__init__.py +0 -0
  251. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkcommentedcode/metadata.toml +0 -0
  252. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkcommitconventions/__init__.py +0 -0
  253. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkcommitconventions/metadata.toml +0 -0
  254. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkconfigsetting/__init__.py +0 -0
  255. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkconfigsetting/metadata.toml +0 -0
  256. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkdependencytable/__init__.py +0 -0
  257. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkdependencytable/metadata.toml +0 -0
  258. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkdevenvsetup/__init__.py +0 -0
  259. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkdevenvsetup/metadata.toml +0 -0
  260. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkdevtools/metadata.toml +0 -0
  261. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkinclude/metadata.toml +0 -0
  262. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkinstallguide/__init__.py +0 -0
  263. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkinstallguide/metadata.toml +0 -0
  264. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mklicense/metadata.toml +0 -0
  265. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkmetadatabadges/metadata.toml +0 -0
  266. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkmoduletable/__init__.py +0 -0
  267. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkmoduletable/metadata.toml +0 -0
  268. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkpipdeptree/metadata.toml +0 -0
  269. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkpluginflow/__init__.py +0 -0
  270. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkpluginflow/metadata.toml +0 -0
  271. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mkshields/metadata.toml +0 -0
  272. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mktemplate/metadata.toml +0 -0
  273. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/templatenodes/mktemplatetable/metadata.toml +0 -0
  274. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/theme/__init__.py +0 -0
  275. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/theme/colortheme.py +0 -0
  276. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/theme/materialtheme/palette.py +0 -0
  277. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/theme/mkgitblog.py +0 -0
  278. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/treelib/__init__.py +0 -0
  279. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/treelib/treeprint.py +0 -0
  280. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/__init__.py +0 -0
  281. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/annotationappender.py +0 -0
  282. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/connector.py +0 -0
  283. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/downloadhelpers.py +0 -0
  284. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/linkreplacer.py +0 -0
  285. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/log.py +0 -0
  286. {mknodes-1.2.0 → mknodes-2.0.0/src}/mknodes/utils/superdict.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: mknodes
3
- Version: 1.2.0
3
+ Version: 2.0.0
4
4
  Summary: Don't write docs. Code them.
5
5
  Keywords: docs,docstrings,documentation,framework,internet,markdown
6
6
  Author: Philipp Temminghoff
@@ -62,7 +62,9 @@ Requires-Dist: pipdeptree
62
62
  Requires-Dist: pydantic
63
63
  Requires-Dist: pytest-asyncio>=1.3.0
64
64
  Requires-Dist: python-dotenv
65
+ Requires-Dist: setuptools>=80.9.0
65
66
  Requires-Dist: tomli-w
67
+ Requires-Dist: typer>=0.12.0
66
68
  Requires-Dist: universal-pathlib
67
69
  Requires-Dist: upathtools[httpx]
68
70
  Requires-Dist: yamling
@@ -2,7 +2,7 @@
2
2
 
3
3
  [project]
4
4
  name = "mknodes"
5
- version = "1.2.0"
5
+ version = "2.0.0"
6
6
  description = "Don't write docs. Code them."
7
7
  readme = "README.md"
8
8
  requires-python = ">=3.13"
@@ -61,7 +61,9 @@ dependencies = [
61
61
  "pytest-asyncio>=1.3.0",
62
62
  "python-dotenv",
63
63
  # Serialization
64
+ "setuptools>=80.9.0",
64
65
  "tomli-w",
66
+ "typer>=0.12.0",
65
67
  "universal_pathlib",
66
68
  "upathtools[httpx]",
67
69
  "yamling",
@@ -72,6 +74,9 @@ dependencies = [
72
74
  Documentation = "https://phil65.github.io/mknodes/"
73
75
  Source = "https://github.com/phil65/mknodes"
74
76
 
77
+ [project.scripts]
78
+ mknodes = "mknodes.cli:main"
79
+
75
80
  [project.entry-points."jinjarope.environment"]
76
81
  mknodes = "mknodes.jinja:setup_env"
77
82
 
@@ -101,6 +106,9 @@ dev = [
101
106
  "pytest-codspeed",
102
107
  "pytest-cov",
103
108
  "ruff",
109
+ "types-Markdown",
110
+ "types-python-dateutil",
111
+ "types-requests",
104
112
  ]
105
113
 
106
114
  [build-system]
@@ -133,7 +141,6 @@ docstring-style = "google"
133
141
 
134
142
  [tool.mypy]
135
143
  python_version = "3.13"
136
- disable_error_code = ["assignment", "misc", "import", "has-type"]
137
144
  check_untyped_defs = true
138
145
 
139
146
  [tool.pyright]
@@ -156,8 +163,8 @@ reportSelfClsParameterName = false
156
163
  reportPrivateImportUsage = false
157
164
  reportUnreachable = false
158
165
 
159
- [tool.pytest.options]
160
- addopts = "--cov=mknodes/ --cov-report=term-missing"
166
+ [tool.pytest]
167
+ addopts = ["--cov-report=term-missing", "--cov=mknodes/"]
161
168
  log_cli = true
162
169
  log_date_format = "%Y-%m-%d %H:%M:%S"
163
170
  log_format = "%(asctime)s %(levelname)s %(message)s"
@@ -300,6 +307,3 @@ combine-as-imports = true
300
307
  # Enable preview style formatting.
301
308
  preview = true
302
309
  docstring-code-format = true
303
-
304
- [tool.uv.build-backend]
305
- module-root = ""
@@ -56,6 +56,8 @@ from .pages.mkmodulepage import MkModulePage
56
56
  from .navs.mknav import MkNav
57
57
  from .navs.mkdoc import MkDoc
58
58
 
59
+ from .build import BuildOutput, DocBuilder, MarkdownExporter
60
+
59
61
  from .templatenodes.mkinclude import MkInclude
60
62
  from .templatenodes.mkshields import MkShields
61
63
  from .templatenodes.mkinstallguide import MkInstallGuide
@@ -90,7 +92,7 @@ from .theme.theme import Theme
90
92
  from .theme.materialtheme import MaterialTheme
91
93
 
92
94
 
93
- def parse(project=None, **kwargs):
95
+ async def parse(project=None, **kwargs):
94
96
  if project:
95
97
  kwargs["context"] = project.context
96
98
  from mknodes.navs.navparser import parse_new_style_nav
@@ -98,13 +100,16 @@ def parse(project=None, **kwargs):
98
100
  pages = kwargs.pop("pages")
99
101
  root_nav = MkNav(**kwargs)
100
102
  project.root = root_nav
101
- parse_new_style_nav(root_nav, pages)
103
+ await parse_new_style_nav(root_nav, pages)
102
104
  return root_nav
103
105
 
104
106
 
105
107
  __version__ = version("mknodes")
106
108
 
107
109
  __all__ = [
110
+ "BuildOutput",
111
+ "DocBuilder",
112
+ "MarkdownExporter",
108
113
  "MaterialTheme",
109
114
  "Metadata",
110
115
  "MkAdmonition",
@@ -119,7 +124,6 @@ __all__ = [
119
124
  "MkClassPage",
120
125
  "MkClassTable",
121
126
  "MkCliDoc",
122
- # "MkGrid",
123
127
  "MkCode",
124
128
  "MkCodeOfConduct",
125
129
  "MkCommandOutput",
@@ -0,0 +1,7 @@
1
+ """Entry point for `python -m mknodes`."""
2
+
3
+ from mknodes.cli import main
4
+
5
+
6
+ if __name__ == "__main__":
7
+ main()
@@ -32,9 +32,9 @@ class MkDocStrings(mknode.MkNode):
32
32
  | str
33
33
  | tuple[str, ...]
34
34
  | list[str]
35
- | os.PathLike
35
+ | os.PathLike[str]
36
36
  | type
37
- | Callable
37
+ | Callable[..., Any]
38
38
  ),
39
39
  for_topmost: bool = True,
40
40
  allow_inspection: bool | None = None,
@@ -202,7 +202,7 @@ class MkDocStrings(mknode.MkNode):
202
202
  opts["show_root_heading"] = True
203
203
  return opts
204
204
 
205
- def _to_markdown(self) -> str:
205
+ async def to_md_unprocessed(self) -> str:
206
206
  md = f"::: {self.obj_path}\n"
207
207
  if not self.options:
208
208
  return md
@@ -72,12 +72,13 @@ class MkAdmonition(mkcontainer.MkContainer):
72
72
  optional = ann_marker + inline_label
73
73
  return f"{block_start} {self.typ}{optional}{title}"
74
74
 
75
- def _to_markdown(self) -> str:
75
+ async def to_md_unprocessed(self) -> str:
76
76
  items = self.get_items()
77
77
  if not items and not self.title:
78
78
  return ""
79
79
  annotations = f"\n{self.annotations}\n" if self.annotations else ""
80
- text = "\n".join(i.to_markdown() for i in items)
80
+ texts = [await i.to_markdown() for i in items]
81
+ text = "\n".join(texts)
81
82
  indented = textwrap.indent(text, " ")
82
83
  return f"{self.title_line}\n{indented}\n{annotations}"
83
84
 
@@ -35,8 +35,9 @@ class MkAnnotation(mkcontainer.MkContainer):
35
35
  def __repr__(self):
36
36
  return reprhelpers.get_repr(self, num=self.num, content=self.get_items())
37
37
 
38
- def _to_markdown(self) -> str:
39
- item_str = "\n\n".join(i.to_markdown() for i in self.get_items())
38
+ async def to_md_unprocessed(self) -> str:
39
+ items = [await i.to_markdown() for i in self.get_items()]
40
+ item_str = "\n\n".join(items)
40
41
  prefix = f"{self.num}."
41
42
  return f"{prefix:<4}{filters.do_indent(item_str)}\n"
42
43
 
@@ -70,7 +71,7 @@ class MkAnnotations(mkcontainer.MkContainer):
70
71
  ]
71
72
  case Mapping():
72
73
  items = [MkAnnotation(k, content=v) for k, v in annotations.items()]
73
- case _:
74
+ case _: # pyright: ignore[reportUnnecessaryComparison]
74
75
  raise TypeError(annotations)
75
76
  super().__init__(content=items, **kwargs)
76
77
 
@@ -94,12 +95,14 @@ class MkAnnotations(mkcontainer.MkContainer):
94
95
  raise TypeError(item)
95
96
 
96
97
  def __repr__(self):
97
- notes = []
98
+ notes: list[str | MkAnnotation] = []
98
99
  for item in self.get_items():
99
100
  item_children = item.get_items()
100
101
  if len(item_children) == 1:
101
- item = reprhelpers.to_str_if_textnode(item_children[0])
102
- notes.append(item)
102
+ string = reprhelpers.to_str_if_textnode(item_children[0])
103
+ notes.append(string)
104
+ else:
105
+ notes.append(item)
103
106
  return reprhelpers.get_repr(self, annotations=notes)
104
107
 
105
108
  def _get_item_pos(self, num: int) -> int:
@@ -125,12 +128,13 @@ class MkAnnotations(mkcontainer.MkContainer):
125
128
  else:
126
129
  items.append(node)
127
130
 
128
- def _to_markdown(self) -> str:
131
+ async def to_md_unprocessed(self) -> str:
129
132
  items = self.get_items()
130
133
  if not items:
131
134
  return ""
132
135
  items = sorted(items, key=lambda x: x.num)
133
- return "".join(i.to_markdown() for i in items)
136
+ texts = [await i.to_markdown() for i in items]
137
+ return "".join(texts)
134
138
 
135
139
  def annotate_text(self, markdown: str) -> str:
136
140
  if not self.get_items():
@@ -111,7 +111,7 @@ class MkBaseTable(mkcontainer.MkContainer):
111
111
  yield [data[k][j] for k in data]
112
112
 
113
113
  @classmethod
114
- def for_items(cls, items, columns: dict[str, Callable[..., Any]]):
114
+ def for_items(cls, items: list[dict[str, Any]], columns: dict[str, Callable[..., Any]]):
115
115
  ls = [{k: v(item) for k, v in columns.items()} for item in items]
116
116
  return cls(ls)
117
117
 
@@ -48,10 +48,9 @@ class MkBlock(mkcontainer.MkContainer):
48
48
  block_level = sum(isinstance(i, MkBlock) for i in self.ancestors)
49
49
  return "/" * (block_level + 3)
50
50
 
51
- @property
52
- def content_block(self) -> str:
51
+ async def get_content_block(self) -> str:
53
52
  """Returns the block content. Can be reimplemented by subclasses."""
54
- text = super()._to_markdown()
53
+ text = await super().to_md_unprocessed()
55
54
  return textwrap.indent(text, self.indent).rstrip("\n") + "\n"
56
55
 
57
56
  @property
@@ -65,12 +64,13 @@ class MkBlock(mkcontainer.MkContainer):
65
64
  lines = [f" {k}: {v}" for k, v in self.attributes.items() if v is not None]
66
65
  return "\n".join(lines) + "\n"
67
66
 
68
- def _to_markdown(self) -> str:
67
+ async def to_md_unprocessed(self) -> str:
69
68
  boundary = self.fence_boundary
70
69
  base = f"{boundary} {self.name}"
71
70
  if self.argument:
72
71
  base += f" | {self.argument}"
73
- return f"{base}\n{self.attributes_block}\n{self.content_block}{boundary}\n"
72
+ content = await self.get_content_block()
73
+ return f"{base}\n{self.attributes_block}\n{content}{boundary}\n"
74
74
 
75
75
 
76
76
  if __name__ == "__main__":
@@ -15,8 +15,8 @@ class MkBlockQuote(mkcontainer.MkContainer):
15
15
  ICON = "material/format-quote-open"
16
16
  STATUS = "new"
17
17
 
18
- def _to_markdown(self) -> str:
19
- text = super()._to_markdown()
18
+ async def to_md_unprocessed(self) -> str:
19
+ text = await super().to_md_unprocessed()
20
20
  return textwrap.indent(text, "> ").rstrip("\n") + "\n"
21
21
 
22
22
 
@@ -66,7 +66,7 @@ class MkCode(mkcontainer.MkContainer):
66
66
  self._fence_level = fence_level
67
67
  super().__init__(content=content, **kwargs)
68
68
 
69
- def get_text(self) -> str:
69
+ async def get_text(self) -> str:
70
70
  """Text content."""
71
71
  return "\n".join(str(i) for i in self.get_items())
72
72
 
@@ -99,10 +99,10 @@ class MkCode(mkcontainer.MkContainer):
99
99
  attr_str = " " + attr_str
100
100
  return f"{{{classes}{attr_str}}}"
101
101
 
102
- def _to_markdown(self) -> str:
102
+ async def to_md_unprocessed(self) -> str:
103
103
  space = " " if self.fence_title else ""
104
104
  first_line = f"{self.fence_boundary}{space}{self.fence_title}"
105
- return f"{first_line}\n{self.get_text()}\n{self.fence_boundary}"
105
+ return f"{first_line}\n{await self.get_text()}\n{self.fence_boundary}"
106
106
 
107
107
  @classmethod
108
108
  def for_file(
@@ -36,7 +36,7 @@ class MkCompactAdmonition(mknode.MkNode):
36
36
  self.typ = typ
37
37
  super().__init__(**kwargs)
38
38
 
39
- def _to_markdown(self) -> str:
39
+ async def to_md_unprocessed(self) -> str:
40
40
  kls = f"mdx-grid-wrapper mdx-admo--{self.typ}" if self.typ else "mdx-grid-wrapper"
41
41
  root = xmlhelpers.Div(kls)
42
42
  xmlhelpers.Div("mdx-grid-child mdx-grid-child--icon", parent=root)
@@ -44,7 +44,7 @@ class MkCompactAdmonition(mknode.MkNode):
44
44
  text_div.text = str(self._text)
45
45
  return root.to_string()
46
46
 
47
- def get_text(self) -> str | mknode.MkNode:
47
+ async def get_text(self) -> str | mknode.MkNode:
48
48
  return self._text
49
49
 
50
50
 
@@ -26,7 +26,7 @@ class MkContainerBase(mknode.MkNode):
26
26
  *,
27
27
  block_separator: str = "\n\n",
28
28
  **kwargs: Any,
29
- ):
29
+ ) -> None:
30
30
  """Constructor.
31
31
 
32
32
  Args:
@@ -46,8 +46,9 @@ class MkContainerBase(mknode.MkNode):
46
46
  def __iter__(self) -> Iterator[mknode.MkNode]:
47
47
  return iter(self.get_items())
48
48
 
49
- def _to_markdown(self) -> str:
50
- return self.block_separator.join(i.to_markdown() for i in self.get_items())
49
+ async def to_md_unprocessed(self) -> str:
50
+ items = [await i.to_markdown() for i in self.get_items()]
51
+ return self.block_separator.join(items)
51
52
 
52
53
  @abstractmethod
53
54
  def get_items(self) -> list[mknode.MkNode]:
@@ -103,7 +104,7 @@ class MkContainer(MkContainerBase):
103
104
  *,
104
105
  block_separator: str = "\n\n",
105
106
  **kwargs: Any,
106
- ):
107
+ ) -> None:
107
108
  """Constructor.
108
109
 
109
110
  Args:
@@ -51,9 +51,10 @@ class MkCritic(mkcontainer.MkContainer):
51
51
  case _:
52
52
  raise TypeError(self.typ)
53
53
 
54
- def _to_markdown(self) -> str:
54
+ async def to_md_unprocessed(self) -> str:
55
55
  left, right = self.marks
56
- return f"{{{left}\n\n{super()._to_markdown()}\n\n{right}}}"
56
+ content = await super().to_md_unprocessed()
57
+ return f"{{{left}\n\n{content}\n\n{right}}}"
57
58
 
58
59
 
59
60
  if __name__ == "__main__":
@@ -42,7 +42,7 @@ class MkDataClassInfo(mknode.MkNode):
42
42
  """Return whether we're dealing with a class or an instance."""
43
43
  return isinstance(self.obj, type)
44
44
 
45
- def _to_markdown(self) -> str:
45
+ async def to_md_unprocessed(self) -> str:
46
46
  """Convert the dataclass to markdown format."""
47
47
  try:
48
48
  obj_fields = fields(self.obj)
@@ -32,8 +32,8 @@ class MkDefinition(mkcontainer.MkContainer):
32
32
  super().__init__(content=content, **kwargs)
33
33
  self.title = title
34
34
 
35
- def _to_markdown(self) -> str:
36
- text = super()._to_markdown()
35
+ async def to_md_unprocessed(self) -> str:
36
+ text = await super().to_md_unprocessed()
37
37
  return f"{self.title}\n: {filters.do_indent(text)}\n"
38
38
 
39
39
 
@@ -62,7 +62,7 @@ class MkDefinitionList(mkcontainer.MkContainer):
62
62
  """Return the list of definition values."""
63
63
  return list(self.data.values()) # type: ignore[arg-type]
64
64
 
65
- def set_items(self, data: Mapping[str, Any] | list | None) -> None:
65
+ def set_items(self, data: Mapping[str, Any] | list[Any] | None) -> None:
66
66
  """Set items from data."""
67
67
  match data:
68
68
  case Mapping():
@@ -71,10 +71,10 @@ class MkDefinitionList(mkcontainer.MkContainer):
71
71
  self.data = {str(i): self.to_child_node(item) for i, item in enumerate(data)}
72
72
  case None:
73
73
  self.data = {}
74
- case _:
74
+ case _: # pyright: ignore[reportUnnecessaryComparison]
75
75
  raise TypeError(data)
76
76
 
77
- def _to_markdown(self) -> str:
77
+ async def to_md_unprocessed(self) -> str:
78
78
  items = [f"{k}\n: {filters.do_indent(str(v))}\n" for k, v in self.data.items()]
79
79
  return "".join(items)
80
80
 
@@ -49,10 +49,11 @@ class MkDetailsBlock(mkblock.MkBlock):
49
49
 
50
50
  def __repr__(self):
51
51
  items = self.get_items()
52
- if len(items) == 1:
53
- content = reprhelpers.to_str_if_textnode(items[0])
54
- else:
55
- content = [reprhelpers.to_str_if_textnode(i) for i in items]
52
+ content = (
53
+ reprhelpers.to_str_if_textnode(items[0])
54
+ if len(items) == 1
55
+ else [reprhelpers.to_str_if_textnode(i) for i in items]
56
+ )
56
57
  return reprhelpers.get_repr(
57
58
  self,
58
59
  content=content,
@@ -6,7 +6,7 @@ import textwrap
6
6
  from typing import Any, Literal
7
7
 
8
8
  from jinjarope import iterfilters, utils
9
- from pymdownx import superfences
9
+ from pymdownx import superfences # type: ignore[import-untyped]
10
10
 
11
11
  from mknodes.basenodes import mkcode
12
12
  from mknodes.utils import resources
@@ -16,7 +16,7 @@ GraphTypeStr = Literal["flow", "sequence", "state"]
16
16
 
17
17
  config = {
18
18
  "custom_fences": [
19
- {"name": "mermaid", "class": "mermaid", "format": superfences.fence_code_format},
19
+ {"name": "mermaid", "class": "mermaid", "format": superfences.fence_code_format}, # pyright: ignore[reportUnknownMemberType]
20
20
  ],
21
21
  }
22
22
 
@@ -53,12 +53,11 @@ class MkDiagram(mkcode.MkCode):
53
53
  self.names = iterfilters.reduce_list(names or [])
54
54
  self.connections = set(connections or [])
55
55
 
56
- def get_text(self) -> str:
56
+ async def get_text(self) -> str:
57
57
  """MkCode override."""
58
- return f"graph {self.direction}\n{self.mermaid_code}"
58
+ return f"graph {self.direction}\n{await self.get_mermaid_code()}"
59
59
 
60
- @property
61
- def mermaid_code(self) -> str:
60
+ async def get_mermaid_code(self) -> str:
62
61
  """Return code block, excluding fences and (graph type direction) line.
63
62
 
64
63
  Can be overriden by subclasses.
@@ -39,8 +39,9 @@ class MkFootNote(mkcontainer.MkContainer):
39
39
  def __repr__(self):
40
40
  return reprhelpers.get_repr(self, num=self.num, content=self.get_items())
41
41
 
42
- def _to_markdown(self) -> str:
43
- item_str = "\n".join(i.to_markdown() for i in self.get_items())
42
+ async def to_md_unprocessed(self) -> str:
43
+ items = [await i.to_markdown() for i in self.get_items()]
44
+ item_str = "\n".join(items)
44
45
  indented = textwrap.indent(item_str, " ")
45
46
  return f"[^{self.num}]:\n{indented}\n"
46
47
 
@@ -127,12 +128,13 @@ class MkFootNotes(mkcontainer.MkContainer):
127
128
  else:
128
129
  items.append(node)
129
130
 
130
- def _to_markdown(self) -> str:
131
+ async def to_md_unprocessed(self) -> str:
131
132
  items = self.get_items()
132
133
  if not items:
133
134
  return ""
134
135
  items = sorted(items, key=lambda x: x.num)
135
- return "".join(i.to_markdown() for i in items)
136
+ texts = [await i.to_markdown() for i in items]
137
+ return "".join(texts)
136
138
 
137
139
 
138
140
  if __name__ == "__main__":
@@ -36,12 +36,12 @@ class MkHeader(mknode.MkNode):
36
36
  self.level = level
37
37
  self.exclude_from_search = exclude_from_search
38
38
 
39
- def _to_markdown(self) -> str:
39
+ async def to_md_unprocessed(self) -> str:
40
40
  level_str = "#" * self.level
41
41
  suffix = " { data-search-exclude }" if self.exclude_from_search else ""
42
42
  return f"{level_str} {self._text}{suffix}"
43
43
 
44
- def get_text(self) -> str:
44
+ async def get_text(self) -> str:
45
45
  return self._text
46
46
 
47
47
 
@@ -51,10 +51,11 @@ class MkHtmlBlock(mkblock.MkBlock):
51
51
 
52
52
  def __repr__(self):
53
53
  items = self.get_items()
54
- if len(items) == 1:
55
- content = reprhelpers.to_str_if_textnode(items[0])
56
- else:
57
- content = [reprhelpers.to_str_if_textnode(i) for i in items]
54
+ content = (
55
+ reprhelpers.to_str_if_textnode(items[0])
56
+ if len(items) == 1
57
+ else [reprhelpers.to_str_if_textnode(i) for i in items]
58
+ )
58
59
  return reprhelpers.get_repr(
59
60
  self,
60
61
  content=content,
@@ -4,7 +4,6 @@ name = "MkHtmlBlock"
4
4
 
5
5
  [requirements.extension."pymdownx.blocks.html"]
6
6
 
7
-
8
7
  [examples.regular]
9
8
  title = "Regular"
10
9
  jinja = """
@@ -16,6 +15,6 @@ template = """
16
15
  {{ node.fence_boundary }} html{% if node.argument %}{{ node.argument | add(prefix=' | ')}}{% endif %}
17
16
  {{ node.attributes_block }}
18
17
 
19
- {{ node.content_block }}{{ node.fence_boundary }}
18
+ {{ node.get_content_block() }}{{ node.fence_boundary }}
20
19
 
21
20
  """
@@ -16,7 +16,7 @@ class MkHtmlTable(mkbasetable.MkBaseTable):
16
16
 
17
17
  STATUS = "new"
18
18
 
19
- def get_element(self) -> xml.Table | None:
19
+ async def get_element(self) -> xml.Table | None:
20
20
  table_data = self.data # property
21
21
  if not any(table_data[k] for k in table_data):
22
22
  return None
@@ -31,11 +31,11 @@ class MkHtmlTable(mkbasetable.MkBaseTable):
31
31
  td.text = "\n" + item + "\n"
32
32
  return root
33
33
 
34
- def _to_markdown(self) -> str:
35
- root = self.get_element()
34
+ async def to_md_unprocessed(self) -> str:
35
+ root = await self.get_element()
36
36
  return root.to_string(space="") if root is not None else ""
37
37
 
38
38
 
39
39
  if __name__ == "__main__":
40
40
  table = MkHtmlTable(data={"Column A": ["A", "B", "C"], "Column B": ["C", "D", "E"]})
41
- print(table._to_markdown())
41
+ print(table.to_md_unprocessed())
@@ -75,7 +75,7 @@ class MkIcon(mknode.MkNode):
75
75
  logger.warning("Could not find icon %r", self.icon_name)
76
76
  return ""
77
77
 
78
- def _to_markdown(self) -> str:
78
+ async def to_md_unprocessed(self) -> str:
79
79
  return self.svg
80
80
 
81
81
 
@@ -74,16 +74,15 @@ class MkImage(mknode.MkNode):
74
74
  case _:
75
75
  return None
76
76
 
77
- @property
78
- def url(self) -> str:
79
- return self.ctx.links.get_url(self.target) if self.target else ""
77
+ async def get_url(self) -> str:
78
+ return await self.ctx.links.get_url(self.target) if self.target else ""
80
79
 
81
- def _to_markdown(self) -> str:
80
+ async def to_md_unprocessed(self) -> str:
82
81
  if not self.path_dark_mode:
83
- markdown_link = self._build(self.path)
82
+ markdown_link = await self._build(self.path)
84
83
  else:
85
- link_2 = self._build(self.path, "light")
86
- link_1 = self._build(self.path_dark_mode, "dark")
84
+ link_2 = await self._build(self.path, "light")
85
+ link_1 = await self._build(self.path_dark_mode, "dark")
87
86
  markdown_link = f"{link_1} {link_2}"
88
87
  if not self.caption:
89
88
  return markdown_link
@@ -95,7 +94,7 @@ class MkImage(mknode.MkNode):
95
94
  ]
96
95
  return "\n".join(lines) + "\n"
97
96
 
98
- def _build(self, path, mode: Literal["light", "dark"] | None = None) -> str:
97
+ async def _build(self, path: str, mode: Literal["light", "dark"] | None = None) -> str:
99
98
  if mode:
100
99
  path += f"#only-{mode}"
101
100
  markdown_link = f"![{self.title}]({path})"
@@ -106,7 +105,7 @@ class MkImage(mknode.MkNode):
106
105
  if self.lazy:
107
106
  markdown_link += "{ loading=lazy }"
108
107
  if self.target:
109
- markdown_link = f"[{markdown_link}]({self.url})"
108
+ markdown_link = f"[{markdown_link}]({await self.get_url()})"
110
109
  return markdown_link
111
110
 
112
111
 
@@ -38,8 +38,8 @@ image = """
38
38
  ![{{ node.title ~ "](" ~ path ~ (mode | add("#only-")) ~ ")" ~ (node.align | add("{ align=", " }")) ~ (node.width | add('{ width="', '" }')) }}{% if node.lazy %}{ loading=lazy }{% endif %}
39
39
  """
40
40
  linked_image = """
41
- {% if node.url %}
42
- [{{ "fragments/image" | render_template(node=node, path=path, mode=mode) }}]({{ node.url }}){% else %}
41
+ {% if node.get_url() %}
42
+ [{{ "fragments/image" | render_template(node=node, path=path, mode=mode) }}]({{ node.get_url() }}){% else %}
43
43
  {{ "fragments/image" | render_template(node=node, path=path, mode=mode) }}{% endif %}
44
44
  """
45
45
 
@@ -78,5 +78,5 @@ template = """
78
78
  {% if node.width %} :width: {{ node.width }}{% endif %}
79
79
  {% if node.caption %} :alt: {{ node.caption }}{% endif %}
80
80
  {% if node.align %} :align: {{ node.align }}{% endif %}
81
- {% if node.url %} :target: {{ node.url }}{% endif %}
81
+ {% if node.get_url() %} :target: {{ node.get_url() }}{% endif %}
82
82
  """
@@ -28,7 +28,7 @@ class MkJupyterLite(mknode.MkNode):
28
28
  self.height = height
29
29
  self.width = width
30
30
 
31
- def _to_markdown(self) -> str:
31
+ async def to_md_unprocessed(self) -> str:
32
32
  encoded_code = quote(self.code)
33
33
  html = f"""
34
34
  <iframe
@@ -37,7 +37,7 @@ class MkKeys(mknode.MkNode):
37
37
  case list():
38
38
  self.keys = [i.lower() for i in keys]
39
39
 
40
- def _to_markdown(self) -> str:
40
+ async def to_md_unprocessed(self) -> str:
41
41
  key_str = "+".join(self.keys)
42
42
  return f"++{key_str}++"
43
43