mknodes 2.0.3__tar.gz → 2.0.5__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 (288) hide show
  1. {mknodes-2.0.3 → mknodes-2.0.5}/PKG-INFO +1 -1
  2. {mknodes-2.0.3 → mknodes-2.0.5}/pyproject.toml +1 -1
  3. mknodes-2.0.5/src/mknodes/build/builder.py +154 -0
  4. mknodes-2.0.5/src/mknodes/build/exporter.py +87 -0
  5. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/build/output.py +12 -6
  6. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/cli/__init__.py +38 -8
  7. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/data/taskrunners.py +0 -13
  8. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/contexts.py +2 -9
  9. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/grifferegistry.py +2 -2
  10. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/license.py +8 -4
  11. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/jinja/filters.py +6 -2
  12. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/manual/root.py +0 -7
  13. mknodes-2.0.5/src/mknodes/manual/standalone.py +54 -0
  14. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/navs/navigation.py +0 -1
  15. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkconfigsetting/__init__.py +1 -1
  16. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/log.py +1 -1
  17. mknodes-2.0.3/src/mknodes/build/builder.py +0 -110
  18. mknodes-2.0.3/src/mknodes/build/exporter.py +0 -168
  19. mknodes-2.0.3/src/mknodes/manual/standalone.py +0 -80
  20. {mknodes-2.0.3 → mknodes-2.0.5}/LICENSE +0 -0
  21. {mknodes-2.0.3 → mknodes-2.0.5}/README.md +0 -0
  22. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/__init__.py +0 -0
  23. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/__main__.py +0 -0
  24. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/__init__.py +0 -0
  25. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/_mkdocstrings/__init__.py +0 -0
  26. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/_mkdocstrings/metadata.toml +0 -0
  27. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkadmonition/__init__.py +0 -0
  28. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkadmonition/metadata.toml +0 -0
  29. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkannotations/__init__.py +0 -0
  30. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkannotations/metadata.toml +0 -0
  31. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkbasetable/__init__.py +0 -0
  32. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkbinaryimage/__init__.py +0 -0
  33. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkbinaryimage/metadata.toml +0 -0
  34. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkblock/__init__.py +0 -0
  35. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkblockquote/__init__.py +0 -0
  36. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkblockquote/metadata.toml +0 -0
  37. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkcard/__init__.py +0 -0
  38. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkcard/grid.css +0 -0
  39. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkcard/metadata.toml +0 -0
  40. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkclidoc/__init__.py +0 -0
  41. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkclidoc/metadata.toml +0 -0
  42. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkcode/__init__.py +0 -0
  43. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkcode/metadata.toml +0 -0
  44. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkcompactadmonition/__init__.py +0 -0
  45. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkcompactadmonition/compactadmonition.css +0 -0
  46. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkcompactadmonition/metadata.toml +0 -0
  47. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkcontainer/__init__.py +0 -0
  48. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkcontainer/metadata.toml +0 -0
  49. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkcritic/__init__.py +0 -0
  50. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkcritic/metadata.toml +0 -0
  51. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkdataclassinfo/__init__.py +0 -0
  52. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkdataclassinfo/metadata.toml +0 -0
  53. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkdefinitionlist/__init__.py +0 -0
  54. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkdefinitionlist/metadata.toml +0 -0
  55. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkdetailsblock/__init__.py +0 -0
  56. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkdetailsblock/metadata.toml +0 -0
  57. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkdiagram/__init__.py +0 -0
  58. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkdiagram/metadata.toml +0 -0
  59. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkfootnotes/__init__.py +0 -0
  60. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkfootnotes/metadata.toml +0 -0
  61. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkheader/__init__.py +0 -0
  62. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkheader/metadata.toml +0 -0
  63. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkhtmlblock/__init__.py +0 -0
  64. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkhtmlblock/metadata.toml +0 -0
  65. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkhtmltable/__init__.py +0 -0
  66. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkhtmltable/metadata.toml +0 -0
  67. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkicon/__init__.py +0 -0
  68. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkicon/metadata.toml +0 -0
  69. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkiframe/__init__.py +0 -0
  70. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkiframe/metadata.toml +0 -0
  71. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkimage/__init__.py +0 -0
  72. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkimage/metadata.toml +0 -0
  73. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkimagecompare/__init__.py +0 -0
  74. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkimagecompare/metadata.toml +0 -0
  75. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkimageslideshow/__init__.py +0 -0
  76. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkimageslideshow/metadata.toml +0 -0
  77. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkjupyterlite/__init__.py +0 -0
  78. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkjupyterlite/metadata.toml +0 -0
  79. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkkeys/__init__.py +0 -0
  80. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkkeys/metadata.toml +0 -0
  81. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mklink/__init__.py +0 -0
  82. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mklink/metadata.toml +0 -0
  83. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mklist/__init__.py +0 -0
  84. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mklist/metadata.toml +0 -0
  85. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkmaterialbadge/__init__.py +0 -0
  86. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkmaterialbadge/materialbadge.css +0 -0
  87. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkmaterialbadge/metadata.toml +0 -0
  88. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mknode/__init__.py +0 -0
  89. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkprogressbar/__init__.py +0 -0
  90. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkprogressbar/metadata.toml +0 -0
  91. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkprogressbar/progressbar.css +0 -0
  92. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkpyodide/__init__.py +0 -0
  93. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkpyodide/metadata.toml +0 -0
  94. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkpyscript/__init__.py +0 -0
  95. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkpyscript/metadata.toml +0 -0
  96. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkshowcase/__init__.py +0 -0
  97. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkshowcase/metadata.toml +0 -0
  98. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkspeechbubble/__init__.py +0 -0
  99. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkspeechbubble/metadata.toml +0 -0
  100. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mkspeechbubble/speechbubble.css +0 -0
  101. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktabbed/__init__.py +0 -0
  102. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktabbed/metadata.toml +0 -0
  103. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktabbedblocks/__init__.py +0 -0
  104. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktabbedblocks/metadata.toml +0 -0
  105. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktabcontainer.py +0 -0
  106. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktable/__init__.py +0 -0
  107. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktable/metadata.toml +0 -0
  108. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktabs/__init__.py +0 -0
  109. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktabs/mktab.toml +0 -0
  110. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktasklist/__init__.py +0 -0
  111. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktasklist/metadata.toml +0 -0
  112. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktext/__init__.py +0 -0
  113. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktext/metadata.toml +0 -0
  114. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktimeline/__init__.py +0 -0
  115. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktimeline/metadata.toml +0 -0
  116. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktimeline/timeline.css +0 -0
  117. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/mktimeline/timeline.js +0 -0
  118. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/basenodes/processors/__init__.py +0 -0
  119. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/build/__init__.py +0 -0
  120. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/data/__init__.py +0 -0
  121. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/data/admonition.py +0 -0
  122. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/data/badges.py +0 -0
  123. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/data/buildsystems.py +0 -0
  124. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/data/commitconventions.py +0 -0
  125. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/data/datatypes.py +0 -0
  126. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/data/eventplugins.py +0 -0
  127. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/data/fences.py +0 -0
  128. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/data/installmethods.py +0 -0
  129. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/data/tools.py +0 -0
  130. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/data/treestyles.py +0 -0
  131. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/extranodes/__init__.py +0 -0
  132. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/extranodes/mkcodeimage/__init__.py +0 -0
  133. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/extranodes/mkcodeimage/metadata.toml +0 -0
  134. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/extranodes/mkgrid/__init__.py +0 -0
  135. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/extranodes/mkgrid/metadata.toml +0 -0
  136. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/extranodes/mkprettyprint/__init__.py +0 -0
  137. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/extranodes/mkprettyprint/metadata.toml +0 -0
  138. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/extranodes/mksnippet/__init__.py +0 -0
  139. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/extranodes/mksnippet/metadata.toml +0 -0
  140. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/__init__.py +0 -0
  141. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/configfile.py +0 -0
  142. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/folderinfo.py +0 -0
  143. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/gitrepository.py +0 -0
  144. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/linkprovider.py +0 -0
  145. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/mkdocsconfigfile.py +0 -0
  146. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/nodefile.py +0 -0
  147. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/packageinfo.py +0 -0
  148. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/packageregistry.py +0 -0
  149. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/pyproject.py +0 -0
  150. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/info/reporegistry.py +0 -0
  151. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/jinja/__init__.py +0 -0
  152. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/jinja/nodeenvironment.py +0 -0
  153. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/manual/__init__.py +0 -0
  154. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/manual/a_quick_tour.py +0 -0
  155. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/manual/dev_section.py +0 -0
  156. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/manual/get_started_section.py +0 -0
  157. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/manual/github_index.py +0 -0
  158. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/manual/navs_section.py +0 -0
  159. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/manual/nodes_section.py +0 -0
  160. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/manual/page_section.py +0 -0
  161. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/manual/routing.py +0 -0
  162. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/manual/templating_section.py +0 -0
  163. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/mdlib/__init__.py +0 -0
  164. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/mdlib/mdconverter.py +0 -0
  165. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/navs/__init__.py +0 -0
  166. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/navs/mkdoc.py +0 -0
  167. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/navs/mknav.py +0 -0
  168. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/navs/navbuilder.py +0 -0
  169. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/navs/navparser.py +0 -0
  170. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/navs/navrouter.py +0 -0
  171. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/navs/router.py +0 -0
  172. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/nodemods/__init__.py +0 -0
  173. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/nodemods/mod.py +0 -0
  174. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/nodemods/modmanager.py +0 -0
  175. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/nodemods/parallax.py +0 -0
  176. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/nodemods/parallax.toml +0 -0
  177. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/nodemods/scrollreveal.py +0 -0
  178. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/nodemods/scrollreveal.toml +0 -0
  179. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/__init__.py +0 -0
  180. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/metadata.py +0 -0
  181. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/mkclasspage/__init__.py +0 -0
  182. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/mkclasspage/classpage.md +0 -0
  183. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/mkclasspage/classpage_tabbed.md +0 -0
  184. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/mkmodulepage/__init__.py +0 -0
  185. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/mkmodulepage/modulepage.md +0 -0
  186. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/mkpage.py +0 -0
  187. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/mktemplatepage.py +0 -0
  188. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/pagetemplate.py +0 -0
  189. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/templateblocks.py +0 -0
  190. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/templateregistry.py +0 -0
  191. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/pages/toc.py +0 -0
  192. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/paths.py +0 -0
  193. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/py.typed +0 -0
  194. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/css/animated.css +0 -0
  195. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/css/hero.css +0 -0
  196. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/css/material_css_extra.jinja +0 -0
  197. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/css/theme_material.css +0 -0
  198. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/css/theme_mkdocs.css +0 -0
  199. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/filters.toml +0 -0
  200. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/js/tablesort.js +0 -0
  201. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/python_objects.inv +0 -0
  202. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/toolfiles/tool_black.toml +0 -0
  203. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/toolfiles/tool_coverage.toml +0 -0
  204. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/toolfiles/tool_mkdocs.toml +0 -0
  205. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/toolfiles/tool_mypy.toml +0 -0
  206. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/toolfiles/tool_precommit.toml +0 -0
  207. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/toolfiles/tool_pyright.toml +0 -0
  208. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/resources/toolfiles/tool_ruff.toml +0 -0
  209. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/__init__.py +0 -0
  210. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkbadge/__init__.py +0 -0
  211. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkbadge/metadata.toml +0 -0
  212. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkchangelog/__init__.py +0 -0
  213. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkchangelog/metadata.toml +0 -0
  214. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkclassdiagram/__init__.py +0 -0
  215. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkclassdiagram/metadata.toml +0 -0
  216. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkclasstable/__init__.py +0 -0
  217. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkclasstable/metadata.toml +0 -0
  218. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkcodeofconduct/__init__.py +0 -0
  219. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkcodeofconduct/metadata.toml +0 -0
  220. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkcommandoutput/__init__.py +0 -0
  221. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkcommandoutput/metadata.toml +0 -0
  222. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkcommandoutput/terminal.css +0 -0
  223. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkcommentedcode/__init__.py +0 -0
  224. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkcommentedcode/metadata.toml +0 -0
  225. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkcommitconventions/__init__.py +0 -0
  226. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkcommitconventions/metadata.toml +0 -0
  227. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkconfigsetting/metadata.toml +0 -0
  228. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkdependencytable/__init__.py +0 -0
  229. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkdependencytable/metadata.toml +0 -0
  230. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkdevenvsetup/__init__.py +0 -0
  231. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkdevenvsetup/metadata.toml +0 -0
  232. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkdevtools/__init__.py +0 -0
  233. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkdevtools/metadata.toml +0 -0
  234. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkinclude/__init__.py +0 -0
  235. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkinclude/metadata.toml +0 -0
  236. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkinstallguide/__init__.py +0 -0
  237. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkinstallguide/metadata.toml +0 -0
  238. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mklicense/__init__.py +0 -0
  239. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mklicense/metadata.toml +0 -0
  240. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkllm/__init__.py +0 -0
  241. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkllm/metadata.toml +0 -0
  242. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkmetadatabadges/__init__.py +0 -0
  243. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkmetadatabadges/metadata.toml +0 -0
  244. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkmoduletable/__init__.py +0 -0
  245. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkmoduletable/metadata.toml +0 -0
  246. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkpipdeptree/__init__.py +0 -0
  247. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkpipdeptree/metadata.toml +0 -0
  248. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkpluginflow/__init__.py +0 -0
  249. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkpluginflow/metadata.toml +0 -0
  250. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkpydeps/__init__.py +0 -0
  251. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkpydeps/metadata.toml +0 -0
  252. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkreprrawrendered/__init__.py +0 -0
  253. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkreprrawrendered/metadata.toml +0 -0
  254. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkshields/__init__.py +0 -0
  255. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mkshields/metadata.toml +0 -0
  256. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mktemplate/__init__.py +0 -0
  257. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mktemplate/metadata.toml +0 -0
  258. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mktemplatetable/__init__.py +0 -0
  259. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mktemplatetable/metadata.toml +0 -0
  260. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mktreeview/__init__.py +0 -0
  261. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/templatenodes/mktreeview/metadata.toml +0 -0
  262. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/theme/__init__.py +0 -0
  263. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/theme/colortheme.py +0 -0
  264. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/theme/materialtheme/__init__.py +0 -0
  265. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/theme/materialtheme/palette.py +0 -0
  266. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/theme/mkblog.py +0 -0
  267. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/theme/mkgitblog.py +0 -0
  268. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/theme/theme.py +0 -0
  269. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/treelib/__init__.py +0 -0
  270. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/treelib/treeprint.py +0 -0
  271. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/__init__.py +0 -0
  272. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/annotationappender.py +0 -0
  273. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/classhelpers.py +0 -0
  274. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/color.py +0 -0
  275. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/connector.py +0 -0
  276. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/coroutines.py +0 -0
  277. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/downloadhelpers.py +0 -0
  278. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/helpers.py +0 -0
  279. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/icons.py +0 -0
  280. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/inspecthelpers.py +0 -0
  281. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/inventorymanager.py +0 -0
  282. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/linkreplacer.py +0 -0
  283. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/packagehelpers.py +0 -0
  284. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/pathhelpers.py +0 -0
  285. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/reprhelpers.py +0 -0
  286. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/resources.py +0 -0
  287. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/superdict.py +0 -0
  288. {mknodes-2.0.3 → mknodes-2.0.5}/src/mknodes/utils/xmlhelpers.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: mknodes
3
- Version: 2.0.3
3
+ Version: 2.0.5
4
4
  Summary: Don't write docs. Code them.
5
5
  Keywords: docs,docstrings,documentation,framework,internet,markdown
6
6
  Author: Philipp Temminghoff
@@ -2,7 +2,7 @@
2
2
 
3
3
  [project]
4
4
  name = "mknodes"
5
- version = "2.0.3"
5
+ version = "2.0.5"
6
6
  description = "Don't write docs. Code them."
7
7
  readme = "README.md"
8
8
  requires-python = ">=3.13"
@@ -0,0 +1,154 @@
1
+ """Core documentation builder."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import asyncio
6
+ from concurrent.futures import ThreadPoolExecutor
7
+ from dataclasses import dataclass
8
+ from typing import TYPE_CHECKING
9
+
10
+ from mknodes.utils import log
11
+
12
+
13
+ if TYPE_CHECKING:
14
+ import mknodes as mk
15
+ from mknodes.utils import resources
16
+
17
+ from .output import BuildOutput
18
+
19
+
20
+ @dataclass
21
+ class PageResult:
22
+ """Result of processing a single page."""
23
+
24
+ path: str
25
+ content: str
26
+ resources: resources.Resources
27
+
28
+
29
+ logger = log.get_logger(__name__)
30
+
31
+
32
+ class DocBuilder:
33
+ """Traverses node tree, renders markdown, collects resources."""
34
+
35
+ def __init__(self, render_jinja: bool = True, max_workers: int | None = None):
36
+ """Constructor.
37
+
38
+ Args:
39
+ render_jinja: Whether to render Jinja templates in pages.
40
+ max_workers: Maximum number of worker threads for parallel processing.
41
+ """
42
+ self.render_jinja = render_jinja
43
+ self.max_workers = max_workers
44
+ self._files: dict[str, str | bytes] = {}
45
+ self._file_resources: dict[str, resources.Resources] = {}
46
+
47
+ async def build(self, root: mk.MkNav) -> BuildOutput:
48
+ """Build documentation from a navigation tree.
49
+
50
+ Args:
51
+ root: Root navigation node to build from.
52
+
53
+ Returns:
54
+ BuildOutput containing all files and collected resources.
55
+ """
56
+ import mknodes as mk
57
+ from mknodes.build.output import BuildOutput
58
+
59
+ logger.info("Starting documentation build...")
60
+
61
+ # Collect all nodes, separate pages and navs
62
+ pages: list[mk.MkPage] = []
63
+ navs: list[mk.MkNav] = []
64
+ for _level, node in root.iter_nodes():
65
+ self._files |= node.files
66
+ match node:
67
+ case mk.MkPage() as page:
68
+ pages.append(page)
69
+ case mk.MkNav() as nav:
70
+ navs.append(nav)
71
+
72
+ # Process pages in parallel
73
+ page_results = await self._process_pages_parallel(pages)
74
+ for result in page_results:
75
+ if result:
76
+ self._files[result.path] = result.content
77
+ self._file_resources[result.path] = result.resources
78
+
79
+ # Process navs (fast, no parallelization needed)
80
+ for nav in navs:
81
+ await self._process_nav(nav)
82
+
83
+ nav_structure = root.nav.to_nav_dict()
84
+ return BuildOutput(
85
+ files=self._files,
86
+ file_resources=self._file_resources,
87
+ nav_structure=nav_structure,
88
+ page_count=len([r for r in page_results if r]),
89
+ )
90
+
91
+ async def _process_pages_parallel(self, pages: list[mk.MkPage]) -> list[PageResult | None]:
92
+ """Process pages in parallel using threads.
93
+
94
+ Args:
95
+ pages: Pages to process.
96
+
97
+ Returns:
98
+ List of PageResult objects (None for skipped pages).
99
+ """
100
+ loop = asyncio.get_running_loop()
101
+ with ThreadPoolExecutor(max_workers=self.max_workers) as pool:
102
+ futures = [loop.run_in_executor(pool, self._process_page_sync, page) for page in pages]
103
+ return list(await asyncio.gather(*futures))
104
+
105
+ def _process_page_sync(self, page: mk.MkPage) -> PageResult | None:
106
+ """Process a page synchronously (for thread pool).
107
+
108
+ Args:
109
+ page: Page to process.
110
+
111
+ Returns:
112
+ PageResult or None if skipped.
113
+ """
114
+ loop = asyncio.new_event_loop()
115
+ asyncio.set_event_loop(loop)
116
+ try:
117
+ return loop.run_until_complete(self._process_page(page))
118
+ finally:
119
+ loop.close()
120
+
121
+ async def _process_page(self, page: mk.MkPage) -> PageResult | None:
122
+ """Process a single page: render and collect resources.
123
+
124
+ Args:
125
+ page: Page to process.
126
+
127
+ Returns:
128
+ PageResult or None if skipped.
129
+ """
130
+ if page.resolved_metadata.inclusion_level is False:
131
+ return None
132
+
133
+ path = page.resolved_file_path
134
+ logger.debug("Processing page: %s", path)
135
+ req = await page.get_resources()
136
+ md = await page.to_markdown()
137
+ if self.render_jinja:
138
+ render = page.metadata.get("render_macros", True)
139
+ if render:
140
+ md = await page.env.render_string_async(md)
141
+ return PageResult(path=path, content=md, resources=req)
142
+
143
+ async def _process_nav(self, nav: mk.MkNav) -> None:
144
+ """Process a navigation section.
145
+
146
+ Args:
147
+ nav: Navigation to process.
148
+ """
149
+ path = nav.resolved_file_path
150
+ logger.debug("Processing nav: %s", nav.title or "[ROOT]")
151
+ req = await nav.get_node_resources()
152
+ self._file_resources[path] = req
153
+ md = await nav.to_markdown()
154
+ self._files[path] = md
@@ -0,0 +1,87 @@
1
+ """Exporters for writing build output to disk."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing import TYPE_CHECKING, Any, Protocol
6
+
7
+ import upath
8
+ import yamling
9
+
10
+
11
+ if TYPE_CHECKING:
12
+ from pathlib import Path
13
+
14
+ from mknodes.build.output import BuildOutput
15
+
16
+
17
+ class Exporter(Protocol):
18
+ """Protocol for exporters."""
19
+
20
+ async def export(self, output: BuildOutput, target: Path) -> None:
21
+ """Export build output to target directory."""
22
+ ...
23
+
24
+
25
+ class MarkdownExporter:
26
+ """Writes markdown files with per-file metadata sidecars."""
27
+
28
+ def __init__(self, metadata_suffix: str = ".meta.yaml"):
29
+ """Constructor.
30
+
31
+ Args:
32
+ metadata_suffix: Suffix for metadata sidecar files.
33
+ """
34
+ self.metadata_suffix = metadata_suffix
35
+
36
+ async def export(self, output: BuildOutput, target: Path) -> None:
37
+ """Export build output to target directory.
38
+
39
+ Args:
40
+ output: Build output to export.
41
+ target: Target directory for output files.
42
+ """
43
+ target_path = upath.UPath(target)
44
+ target_path.mkdir(parents=True, exist_ok=True)
45
+
46
+ for file_path, content in output.files.items():
47
+ full_path = target_path / file_path
48
+ full_path.parent.mkdir(parents=True, exist_ok=True)
49
+
50
+ # Write content
51
+ if isinstance(content, bytes):
52
+ full_path.write_bytes(content)
53
+ else:
54
+ full_path.write_text(content, encoding="utf-8")
55
+ # Write metadata sidecar with per-file resources
56
+ metadata: dict[str, Any] = {"generated_by": "mknodes", "path": file_path}
57
+ if file_resources := output.file_resources.get(file_path):
58
+ metadata["resources"] = self._serialize_resources(file_resources)
59
+ meta_path = full_path.with_suffix(full_path.suffix + self.metadata_suffix)
60
+ meta_path.write_text(yamling.dump_yaml(metadata, indent=2), encoding="utf-8")
61
+
62
+ # Write combined metadata file
63
+ meta: dict[str, Any] = {}
64
+ merged = output.merged_resources
65
+ if any([
66
+ merged.markdown_extensions,
67
+ merged.css,
68
+ merged.js,
69
+ merged.plugins,
70
+ merged.packages,
71
+ ]):
72
+ meta["resources"] = self._serialize_resources(merged)
73
+ if output.nav_structure:
74
+ meta["nav"] = output.nav_structure
75
+ if meta:
76
+ meta_path = target_path / ".mknodes.meta.yaml"
77
+ meta_path.write_text(yamling.dump_yaml(meta, indent=2), encoding="utf-8")
78
+
79
+ def _serialize_resources(self, res) -> dict[str, Any]:
80
+ """Serialize a Resources object to a dict."""
81
+ return {
82
+ "markdown_extensions": res.markdown_extensions,
83
+ "css": res.css,
84
+ "js": res.js,
85
+ "plugins": res.plugins,
86
+ "packages": res.packages,
87
+ }
@@ -3,11 +3,9 @@
3
3
  from __future__ import annotations
4
4
 
5
5
  import dataclasses
6
- from typing import TYPE_CHECKING, Any
6
+ from typing import Any
7
7
 
8
-
9
- if TYPE_CHECKING:
10
- from mknodes.utils import resources as res
8
+ from mknodes.utils import resources
11
9
 
12
10
 
13
11
  @dataclasses.dataclass
@@ -17,8 +15,8 @@ class BuildOutput:
17
15
  files: dict[str, str | bytes] = dataclasses.field(default_factory=dict)
18
16
  """Mapping of file paths to markdown/content."""
19
17
 
20
- resources: res.Resources | None = None
21
- """Collected resources (JS, CSS, extensions)."""
18
+ file_resources: dict[str, resources.Resources] = dataclasses.field(default_factory=dict)
19
+ """Mapping of file paths to their resources."""
22
20
 
23
21
  nav_structure: dict[str, Any] = dataclasses.field(default_factory=dict)
24
22
  """Navigation structure for downstream consumers."""
@@ -26,5 +24,13 @@ class BuildOutput:
26
24
  page_count: int = 0
27
25
  """Number of pages built."""
28
26
 
27
+ @property
28
+ def merged_resources(self) -> resources.Resources:
29
+ """Return all resources merged into one."""
30
+ merged = resources.Resources()
31
+ for res in self.file_resources.values():
32
+ merged.merge(res)
33
+ return merged
34
+
29
35
  def __repr__(self) -> str:
30
36
  return f"{type(self).__name__}(files={len(self.files)}, pages={self.page_count})"
@@ -7,9 +7,13 @@ import logging
7
7
  import sys
8
8
  from pathlib import Path
9
9
 
10
+ import jinjarope
10
11
  import typer as t
11
12
 
12
13
  from mknodes.utils import classhelpers, log
14
+ import mknodes as mk
15
+ from mknodes.info import contexts, folderinfo, reporegistry
16
+ from mknodes.info.linkprovider import LinkProvider
13
17
 
14
18
 
15
19
  logger = log.get_logger(__name__)
@@ -29,6 +33,7 @@ VERBOSE_HELP = "Enable verbose output (DEBUG level)."
29
33
  QUIET_HELP = "Suppress output during build."
30
34
  INPUT_HELP = "Input markdown file to render (use - for stdin)."
31
35
  OUTPUT_FILE_HELP = "Output file (use - for stdout, default)."
36
+ WORKERS_HELP = "Number of parallel workers for page processing. Set PYTHON_GIL=0 for best performance with Python 3.14t."
32
37
 
33
38
  SCRIPT_CMDS = "-s", "--script"
34
39
  OUTPUT_CMDS = "-o", "--output"
@@ -37,6 +42,7 @@ VERBOSE_CMDS = "-v", "--verbose"
37
42
  QUIET_CMDS = "-q", "--quiet"
38
43
  INPUT_CMDS = "-i", "--input"
39
44
  OUTPUT_FILE_CMDS = "-o", "--output"
45
+ WORKERS_CMDS = "-w", "--workers"
40
46
 
41
47
 
42
48
  def verbose_callback(ctx: t.Context, _param: t.CallbackParam, value: bool):
@@ -55,6 +61,7 @@ def build(
55
61
  output: Path = t.Option(Path("docs"), *OUTPUT_CMDS, help=OUTPUT_HELP), # noqa: B008
56
62
  repo_url: str | None = t.Option(None, *REPO_CMDS, help=REPO_HELP, show_default=False),
57
63
  render_jinja: bool = t.Option(True, "--render-jinja/--no-render-jinja", help=RENDER_JINJA_HELP),
64
+ workers: int | None = t.Option(None, *WORKERS_CMDS, help=WORKERS_HELP),
58
65
  _verbose: bool = t.Option(False, *VERBOSE_CMDS, help=VERBOSE_HELP, callback=verbose_callback),
59
66
  _quiet: bool = t.Option(False, *QUIET_CMDS, help=QUIET_HELP, callback=quiet_callback),
60
67
  ) -> None:
@@ -62,22 +69,46 @@ def build(
62
69
 
63
70
  The build script should be a function that takes a root MkNav and populates it.
64
71
 
72
+ For best parallel performance with Python 3.14t (free-threaded), run with:
73
+ PYTHON_GIL=0 mknodes build -s mypackage.docs:build
74
+
65
75
  Example:
66
- mkdocs-mknodes build -s mypackage.docs:build -o ./docs
76
+ mknodes build -s mypackage.docs:build -o ./docs
67
77
  """
68
- asyncio.run(_build_async(script, output, repo_url, render_jinja))
78
+ asyncio.run(_build_async(script, output, repo_url, render_jinja, workers))
69
79
 
70
80
 
71
- async def _build_async(script: str, output: Path, repo_url: str | None, render_jinja: bool) -> None:
81
+ async def _build_async(
82
+ script: str,
83
+ output: Path,
84
+ repo_url: str | None,
85
+ render_jinja: bool,
86
+ max_workers: int | None,
87
+ ) -> None:
72
88
  """Async implementation of build command."""
73
- import mknodes as mk
74
89
  from mknodes.build import DocBuilder, MarkdownExporter
75
90
 
76
91
  logger.info("Loading build script: %s", script)
77
92
  build_fn = classhelpers.to_callable(script)
78
93
 
79
- # Create root nav with optional repo context
80
- root = mk.MkNav.with_context(repo_url=repo_url) if repo_url else mk.MkNav()
94
+ linkprovider = LinkProvider(
95
+ base_url="",
96
+ use_directory_urls=True,
97
+ include_stdlib=True,
98
+ )
99
+ theme = mk.Theme.get_theme(theme_name="material")
100
+ git_repo = reporegistry.get_repo(".", clone_depth=50)
101
+ assert theme
102
+ info = folderinfo.FolderInfo(git_repo.working_dir)
103
+ context = contexts.ProjectContext(
104
+ metadata=info.context,
105
+ git=info.git.context,
106
+ # github=info.github.context,
107
+ theme=theme.context,
108
+ links=linkprovider,
109
+ env_config=jinjarope.EnvConfig(loader=contexts.DEFAULT_LOADER),
110
+ )
111
+ root = mk.MkNav(context=context)
81
112
 
82
113
  logger.info("Executing build script...")
83
114
  result = build_fn(root)
@@ -87,7 +118,7 @@ async def _build_async(script: str, output: Path, repo_url: str | None, render_j
87
118
  root = result
88
119
 
89
120
  logger.info("Building documentation tree...")
90
- builder = DocBuilder(render_jinja=render_jinja)
121
+ builder = DocBuilder(render_jinja=render_jinja, max_workers=max_workers)
91
122
  build_output = await builder.build(root)
92
123
 
93
124
  logger.info("Exporting to %s...", output)
@@ -122,7 +153,6 @@ def render(
122
153
 
123
154
  async def _render_async(input_file: str, output_file: str, repo_url: str | None) -> None:
124
155
  """Async implementation of render command."""
125
- import mknodes as mk
126
156
  from mknodes.jinja import nodeenvironment
127
157
 
128
158
  # Read input
@@ -16,19 +16,6 @@ class TaskRunner:
16
16
  TaskRunnerStr = Literal["makefile", "task", "just", "duty", "invoke", "doit"]
17
17
 
18
18
 
19
- # class MakeFile(TaskRunner):
20
- # def get_commands(self) -> dict[str, str]:
21
- # import re
22
-
23
- # dct = {}
24
- # text = ""
25
- # for line in text.splitlines():
26
- # if match := re.match(r"^([a-zA-Z_-]+):.*?## (.*)$$", line):
27
- # target, help_text = match.groups()
28
- # dct[target] = help_text
29
- # return dct
30
-
31
-
32
19
  makefile = TaskRunner(
33
20
  identifier="makefile",
34
21
  website="https://www.gnu.org/software/make/manual/make.html",
@@ -12,11 +12,7 @@ import jinjarope
12
12
 
13
13
  import mknodes as mk
14
14
  from mknodes.data import buildsystems
15
- from mknodes.info import (
16
- linkprovider,
17
- packageregistry,
18
- pyproject,
19
- )
15
+ from mknodes.info import linkprovider, packageregistry, pyproject
20
16
  from mknodes.utils import log, superdict
21
17
 
22
18
 
@@ -28,10 +24,7 @@ if TYPE_CHECKING:
28
24
  from griffe import Alias, Module
29
25
 
30
26
  from mknodes.data import commitconventions, installmethods, tools
31
- from mknodes.info import (
32
- folderinfo,
33
- mkdocsconfigfile,
34
- )
27
+ from mknodes.info import folderinfo, mkdocsconfigfile
35
28
  from mknodes.info.packageinfo import PackageInfo
36
29
  from mknodes.utils.packagehelpers import Dependency
37
30
 
@@ -76,7 +76,7 @@ class GriffeRegistry(MutableMapping[str, griffe.Module], metaclass=ABCMeta):
76
76
  def get_module(
77
77
  self,
78
78
  module: str | types.ModuleType,
79
- docstring_style: str = "google",
79
+ docstring_style: griffe.Parser = griffe.Parser.auto,
80
80
  ) -> griffe.Module | griffe.Alias:
81
81
  """Get griffe Module for given module.
82
82
 
@@ -105,7 +105,7 @@ class GriffeRegistry(MutableMapping[str, griffe.Module], metaclass=ABCMeta):
105
105
  def get_class(
106
106
  self,
107
107
  klass: str | type,
108
- docstring_style: str = "google",
108
+ docstring_style: griffe.Parser = griffe.Parser.auto,
109
109
  ) -> griffe.Class | griffe.Alias:
110
110
  """Get griffe Class for given class.
111
111
 
@@ -1,15 +1,19 @@
1
1
  from __future__ import annotations
2
2
 
3
3
  import dataclasses
4
- import pathlib
5
- from typing import Any, Self
4
+ from typing import TYPE_CHECKING, Any, Self
6
5
 
7
6
  import anyenv
8
7
  from anyio import functools as anyio_functools
8
+ import upath
9
9
 
10
10
  from mknodes.utils import log
11
11
 
12
12
 
13
+ if TYPE_CHECKING:
14
+ from upath.types import JoinablePathLike
15
+
16
+
13
17
  logger = log.get_logger(__name__)
14
18
  DB_URL = "https://raw.githubusercontent.com/fsfe/reuse-tool/refs/heads/main/src/reuse/resources/licenses.json"
15
19
 
@@ -53,13 +57,13 @@ class License:
53
57
  raise ValueError(name_or_id)
54
58
 
55
59
  @classmethod
56
- def from_path(cls, path: str) -> Self:
60
+ def from_path(cls, path: JoinablePathLike) -> Self:
57
61
  """Get a license from a file path.
58
62
 
59
63
  Args:
60
64
  path: Path to get license from.
61
65
  """
62
- p = pathlib.Path(path)
66
+ p = upath.Uath(path)
63
67
  content = p.read_text(encoding="utf-8")
64
68
  return cls(path=str(p), content=content, name=p.name, identifier=p.name)
65
69
 
@@ -12,6 +12,7 @@ if TYPE_CHECKING:
12
12
 
13
13
  import griffe
14
14
  from jinja2 import runtime
15
+ from mkdocs.config.config_options import ExtraScriptValue
15
16
 
16
17
  import mknodes as mk
17
18
  from mknodes.info.linkprovider import LinkableType
@@ -114,7 +115,7 @@ def url(context: runtime.Context, value: str) -> str:
114
115
 
115
116
 
116
117
  @jinja2.pass_context
117
- def script_tag(context: runtime.Context, extra_script: str | JSFile | JSText):
118
+ def script_tag(context: runtime.Context, extra_script: str | JSFile | JSText | ExtraScriptValue):
118
119
  """Converts an ExtraScript value / JSResource to an HTML <script> tag line.
119
120
 
120
121
  Args:
@@ -123,7 +124,10 @@ def script_tag(context: runtime.Context, extra_script: str | JSFile | JSText):
123
124
  """
124
125
  html = '<script src="{0}"'
125
126
  if not isinstance(extra_script, str):
126
- if extra_script.typ:
127
+ # bw compat for now, should all be type at some point.
128
+ if hasattr(extra_script, "typ") and extra_script.typ: # pyright: ignore[reportAttributeAccessIssue]
129
+ html += ' type="{1.type}"' # type or typ?
130
+ if hasattr(extra_script, "type") and extra_script.type:
127
131
  html += ' type="{1.type}"' # type or typ?
128
132
  if extra_script.defer:
129
133
  html += " defer"
@@ -9,13 +9,6 @@ from mknodes.manual import (
9
9
  )
10
10
 
11
11
 
12
- def build(project) -> mk.MkNav:
13
- build = Build()
14
- project.linkprovider.add_inv_file("https://mkdocstrings.github.io/objects.inv")
15
- build.on_theme(project.theme)
16
- return build.on_root(project.root) or project.root
17
-
18
-
19
12
  class Build:
20
13
  @classmethod
21
14
  def build(cls, root: mk.MkNav, theme: mk.Theme):
@@ -0,0 +1,54 @@
1
+ """Simple standalone build script for testing the mknodes CLI.
2
+
3
+ Usage:
4
+ mknodes -s mknodes.manual.standalone:build -o ./docs
5
+ """
6
+
7
+ from __future__ import annotations
8
+
9
+ import mknodes as mk
10
+ from mknodes.manual import (
11
+ dev_section,
12
+ get_started_section,
13
+ navs_section,
14
+ nodes_section,
15
+ page_section,
16
+ templating_section,
17
+ )
18
+
19
+
20
+ def build(root: mk.MkNav) -> mk.MkNav:
21
+ """Build a simple documentation structure.
22
+
23
+ Args:
24
+ root: Root navigation node to populate.
25
+
26
+ Returns:
27
+ The populated navigation node.
28
+ """
29
+ # Create index page
30
+ index = root.add_page("Welcome", is_index=True)
31
+ index += mk.MkHeader("Welcome to MkNodes")
32
+ index += mk.MkText("This is a simple example of standalone mknodes documentation.")
33
+ index += mk.MkAdmonition(
34
+ "MkNodes lets you build documentation programmatically!",
35
+ typ="info",
36
+ title="About MkNodes",
37
+ )
38
+ root.page_template.announcement_bar = mk.MkMetadataBadges("websites")
39
+ root += get_started_section.nav
40
+ root += navs_section.nav
41
+ root += page_section.nav
42
+ root += nodes_section.nav
43
+ root += templating_section.nav
44
+ root += dev_section.nav
45
+ return root
46
+
47
+
48
+ if __name__ == "__main__":
49
+ # Quick test: build and print structure
50
+ nav = mk.MkNav()
51
+ build(nav)
52
+ for level, node in nav.iter_nodes():
53
+ indent = " " * level
54
+ print(f"{indent}{type(node).__name__}: {getattr(node, 'title', '')}")
@@ -73,7 +73,6 @@ class Navigation:
73
73
 
74
74
  @property
75
75
  def index_page(self) -> mkpage.MkPage | None:
76
- self._ensure_materialized()
77
76
  return self._index_page
78
77
 
79
78
  @index_page.setter
@@ -22,7 +22,7 @@ class MkConfigSetting(mktemplate.MkTemplate):
22
22
  default: str | int | None = None,
23
23
  version_added: str | None = None,
24
24
  optional: bool | None = None,
25
- mode: superdict.MarkupTypeStr | None = None,
25
+ mode: superdict.MarkupTypeStr = "yaml",
26
26
  **kwargs: Any,
27
27
  ) -> None:
28
28
  """Constructor.
@@ -28,7 +28,7 @@ def get_logger(name: str | None = None):
28
28
 
29
29
 
30
30
  def basic() -> None:
31
- logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
31
+ logging.basicConfig(stream=sys.stdout, level=logging.INFO)
32
32
 
33
33
 
34
34
  log_stream = io.StringIO()