mknodes 2.0.0__tar.gz → 2.0.0a4__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 (285) hide show
  1. {mknodes-2.0.0 → mknodes-2.0.0a4}/PKG-INFO +1 -2
  2. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/__init__.py +1 -5
  3. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/navs/navparser.py +1 -1
  4. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkllm/__init__.py +2 -2
  5. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkpydeps/__init__.py +1 -1
  6. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mktreeview/metadata.toml +5 -5
  7. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/theme/theme.py +1 -1
  8. {mknodes-2.0.0 → mknodes-2.0.0a4}/pyproject.toml +4 -5
  9. mknodes-2.0.0/src/mknodes/__main__.py +0 -7
  10. mknodes-2.0.0/src/mknodes/build/__init__.py +0 -10
  11. mknodes-2.0.0/src/mknodes/build/builder.py +0 -110
  12. mknodes-2.0.0/src/mknodes/build/exporter.py +0 -168
  13. mknodes-2.0.0/src/mknodes/build/output.py +0 -30
  14. mknodes-2.0.0/src/mknodes/cli/__init__.py +0 -164
  15. mknodes-2.0.0/src/mknodes/manual/standalone.py +0 -80
  16. {mknodes-2.0.0 → mknodes-2.0.0a4}/LICENSE +0 -0
  17. {mknodes-2.0.0 → mknodes-2.0.0a4}/README.md +0 -0
  18. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/__init__.py +0 -0
  19. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/_mkdocstrings/__init__.py +0 -0
  20. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/_mkdocstrings/metadata.toml +0 -0
  21. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkadmonition/__init__.py +0 -0
  22. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkadmonition/metadata.toml +0 -0
  23. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkannotations/__init__.py +0 -0
  24. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkannotations/metadata.toml +0 -0
  25. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkbasetable/__init__.py +0 -0
  26. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkbinaryimage/__init__.py +0 -0
  27. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkbinaryimage/metadata.toml +0 -0
  28. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkblock/__init__.py +0 -0
  29. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkblockquote/__init__.py +0 -0
  30. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkblockquote/metadata.toml +0 -0
  31. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkcard/__init__.py +0 -0
  32. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkcard/grid.css +0 -0
  33. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkcard/metadata.toml +0 -0
  34. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkclidoc/__init__.py +0 -0
  35. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkclidoc/metadata.toml +0 -0
  36. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkcode/__init__.py +0 -0
  37. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkcode/metadata.toml +0 -0
  38. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkcompactadmonition/__init__.py +0 -0
  39. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkcompactadmonition/compactadmonition.css +0 -0
  40. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkcompactadmonition/metadata.toml +0 -0
  41. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkcontainer/__init__.py +0 -0
  42. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkcontainer/metadata.toml +0 -0
  43. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkcritic/__init__.py +0 -0
  44. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkcritic/metadata.toml +0 -0
  45. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkdataclassinfo/__init__.py +0 -0
  46. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkdataclassinfo/metadata.toml +0 -0
  47. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkdefinitionlist/__init__.py +0 -0
  48. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkdefinitionlist/metadata.toml +0 -0
  49. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkdetailsblock/__init__.py +0 -0
  50. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkdetailsblock/metadata.toml +0 -0
  51. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkdiagram/__init__.py +0 -0
  52. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkdiagram/metadata.toml +0 -0
  53. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkfootnotes/__init__.py +0 -0
  54. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkfootnotes/metadata.toml +0 -0
  55. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkheader/__init__.py +0 -0
  56. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkheader/metadata.toml +0 -0
  57. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkhtmlblock/__init__.py +0 -0
  58. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkhtmlblock/metadata.toml +0 -0
  59. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkhtmltable/__init__.py +0 -0
  60. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkhtmltable/metadata.toml +0 -0
  61. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkicon/__init__.py +0 -0
  62. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkicon/metadata.toml +0 -0
  63. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkiframe/__init__.py +0 -0
  64. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkiframe/metadata.toml +0 -0
  65. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkimage/__init__.py +0 -0
  66. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkimage/metadata.toml +0 -0
  67. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkimagecompare/__init__.py +0 -0
  68. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkimagecompare/metadata.toml +0 -0
  69. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkimageslideshow/__init__.py +0 -0
  70. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkimageslideshow/metadata.toml +0 -0
  71. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkjupyterlite/__init__.py +0 -0
  72. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkjupyterlite/metadata.toml +0 -0
  73. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkkeys/__init__.py +0 -0
  74. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkkeys/metadata.toml +0 -0
  75. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mklink/__init__.py +0 -0
  76. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mklink/metadata.toml +0 -0
  77. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mklist/__init__.py +0 -0
  78. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mklist/metadata.toml +0 -0
  79. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkmaterialbadge/__init__.py +0 -0
  80. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkmaterialbadge/materialbadge.css +0 -0
  81. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkmaterialbadge/metadata.toml +0 -0
  82. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mknode/__init__.py +0 -0
  83. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkprogressbar/__init__.py +0 -0
  84. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkprogressbar/metadata.toml +0 -0
  85. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkprogressbar/progressbar.css +0 -0
  86. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkpyodide/__init__.py +0 -0
  87. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkpyodide/metadata.toml +0 -0
  88. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkpyscript/__init__.py +0 -0
  89. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkpyscript/metadata.toml +0 -0
  90. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkshowcase/__init__.py +0 -0
  91. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkshowcase/metadata.toml +0 -0
  92. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkspeechbubble/__init__.py +0 -0
  93. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkspeechbubble/metadata.toml +0 -0
  94. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mkspeechbubble/speechbubble.css +0 -0
  95. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktabbed/__init__.py +0 -0
  96. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktabbed/metadata.toml +0 -0
  97. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktabbedblocks/__init__.py +0 -0
  98. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktabbedblocks/metadata.toml +0 -0
  99. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktabcontainer.py +0 -0
  100. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktable/__init__.py +0 -0
  101. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktable/metadata.toml +0 -0
  102. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktabs/__init__.py +0 -0
  103. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktabs/mktab.toml +0 -0
  104. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktasklist/__init__.py +0 -0
  105. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktasklist/metadata.toml +0 -0
  106. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktext/__init__.py +0 -0
  107. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktext/metadata.toml +0 -0
  108. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktimeline/__init__.py +0 -0
  109. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktimeline/metadata.toml +0 -0
  110. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktimeline/timeline.css +0 -0
  111. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/mktimeline/timeline.js +0 -0
  112. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/basenodes/processors/__init__.py +0 -0
  113. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/data/__init__.py +0 -0
  114. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/data/admonition.py +0 -0
  115. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/data/badges.py +0 -0
  116. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/data/buildsystems.py +0 -0
  117. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/data/commitconventions.py +0 -0
  118. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/data/datatypes.py +0 -0
  119. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/data/eventplugins.py +0 -0
  120. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/data/fences.py +0 -0
  121. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/data/installmethods.py +0 -0
  122. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/data/taskrunners.py +0 -0
  123. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/data/tools.py +0 -0
  124. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/data/treestyles.py +0 -0
  125. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/extranodes/__init__.py +0 -0
  126. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/extranodes/mkcodeimage/__init__.py +0 -0
  127. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/extranodes/mkcodeimage/metadata.toml +0 -0
  128. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/extranodes/mkgrid/__init__.py +0 -0
  129. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/extranodes/mkgrid/metadata.toml +0 -0
  130. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/extranodes/mkprettyprint/__init__.py +0 -0
  131. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/extranodes/mkprettyprint/metadata.toml +0 -0
  132. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/extranodes/mksnippet/__init__.py +0 -0
  133. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/extranodes/mksnippet/metadata.toml +0 -0
  134. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/__init__.py +0 -0
  135. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/configfile.py +0 -0
  136. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/contexts.py +0 -0
  137. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/folderinfo.py +0 -0
  138. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/gitrepository.py +0 -0
  139. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/grifferegistry.py +0 -0
  140. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/license.py +0 -0
  141. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/linkprovider.py +0 -0
  142. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/mkdocsconfigfile.py +0 -0
  143. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/nodefile.py +0 -0
  144. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/packageinfo.py +0 -0
  145. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/packageregistry.py +0 -0
  146. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/pyproject.py +0 -0
  147. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/info/reporegistry.py +0 -0
  148. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/jinja/__init__.py +0 -0
  149. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/jinja/filters.py +0 -0
  150. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/jinja/nodeenvironment.py +0 -0
  151. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/manual/__init__.py +0 -0
  152. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/manual/a_quick_tour.py +0 -0
  153. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/manual/dev_section.py +0 -0
  154. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/manual/get_started_section.py +0 -0
  155. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/manual/github_index.py +0 -0
  156. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/manual/navs_section.py +0 -0
  157. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/manual/nodes_section.py +0 -0
  158. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/manual/page_section.py +0 -0
  159. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/manual/root.py +0 -0
  160. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/manual/routing.py +0 -0
  161. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/manual/templating_section.py +0 -0
  162. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/mdlib/__init__.py +0 -0
  163. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/mdlib/mdconverter.py +0 -0
  164. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/navs/__init__.py +0 -0
  165. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/navs/mkdoc.py +0 -0
  166. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/navs/mknav.py +0 -0
  167. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/navs/navbuilder.py +0 -0
  168. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/navs/navigation.py +0 -0
  169. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/navs/navrouter.py +0 -0
  170. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/navs/router.py +0 -0
  171. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/nodemods/__init__.py +0 -0
  172. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/nodemods/mod.py +0 -0
  173. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/nodemods/modmanager.py +0 -0
  174. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/nodemods/parallax.py +0 -0
  175. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/nodemods/parallax.toml +0 -0
  176. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/nodemods/scrollreveal.py +0 -0
  177. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/nodemods/scrollreveal.toml +0 -0
  178. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/__init__.py +0 -0
  179. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/metadata.py +0 -0
  180. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/mkclasspage/__init__.py +0 -0
  181. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/mkclasspage/classpage.md +0 -0
  182. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/mkclasspage/classpage_tabbed.md +0 -0
  183. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/mkmodulepage/__init__.py +0 -0
  184. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/mkmodulepage/modulepage.md +0 -0
  185. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/mkpage.py +0 -0
  186. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/mktemplatepage.py +0 -0
  187. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/pagetemplate.py +0 -0
  188. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/templateblocks.py +0 -0
  189. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/templateregistry.py +0 -0
  190. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/pages/toc.py +0 -0
  191. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/paths.py +0 -0
  192. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/py.typed +0 -0
  193. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/css/animated.css +0 -0
  194. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/css/hero.css +0 -0
  195. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/css/material_css_extra.jinja +0 -0
  196. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/css/theme_material.css +0 -0
  197. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/css/theme_mkdocs.css +0 -0
  198. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/filters.toml +0 -0
  199. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/js/tablesort.js +0 -0
  200. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/python_objects.inv +0 -0
  201. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/toolfiles/tool_black.toml +0 -0
  202. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/toolfiles/tool_coverage.toml +0 -0
  203. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/toolfiles/tool_mkdocs.toml +0 -0
  204. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/toolfiles/tool_mypy.toml +0 -0
  205. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/toolfiles/tool_precommit.toml +0 -0
  206. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/toolfiles/tool_pyright.toml +0 -0
  207. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/resources/toolfiles/tool_ruff.toml +0 -0
  208. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/__init__.py +0 -0
  209. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkbadge/__init__.py +0 -0
  210. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkbadge/metadata.toml +0 -0
  211. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkchangelog/__init__.py +0 -0
  212. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkchangelog/metadata.toml +0 -0
  213. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkclassdiagram/__init__.py +0 -0
  214. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkclassdiagram/metadata.toml +0 -0
  215. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkclasstable/__init__.py +0 -0
  216. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkclasstable/metadata.toml +0 -0
  217. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkcodeofconduct/__init__.py +0 -0
  218. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkcodeofconduct/metadata.toml +0 -0
  219. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkcommandoutput/__init__.py +0 -0
  220. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkcommandoutput/metadata.toml +0 -0
  221. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkcommandoutput/terminal.css +0 -0
  222. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkcommentedcode/__init__.py +0 -0
  223. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkcommentedcode/metadata.toml +0 -0
  224. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkcommitconventions/__init__.py +0 -0
  225. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkcommitconventions/metadata.toml +0 -0
  226. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkconfigsetting/__init__.py +0 -0
  227. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkconfigsetting/metadata.toml +0 -0
  228. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkdependencytable/__init__.py +0 -0
  229. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkdependencytable/metadata.toml +0 -0
  230. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkdevenvsetup/__init__.py +0 -0
  231. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkdevenvsetup/metadata.toml +0 -0
  232. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkdevtools/__init__.py +0 -0
  233. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkdevtools/metadata.toml +0 -0
  234. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkinclude/__init__.py +0 -0
  235. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkinclude/metadata.toml +0 -0
  236. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkinstallguide/__init__.py +0 -0
  237. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkinstallguide/metadata.toml +0 -0
  238. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mklicense/__init__.py +0 -0
  239. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mklicense/metadata.toml +0 -0
  240. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkllm/metadata.toml +0 -0
  241. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkmetadatabadges/__init__.py +0 -0
  242. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkmetadatabadges/metadata.toml +0 -0
  243. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkmoduletable/__init__.py +0 -0
  244. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkmoduletable/metadata.toml +0 -0
  245. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkpipdeptree/__init__.py +0 -0
  246. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkpipdeptree/metadata.toml +0 -0
  247. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkpluginflow/__init__.py +0 -0
  248. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkpluginflow/metadata.toml +0 -0
  249. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkpydeps/metadata.toml +0 -0
  250. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkreprrawrendered/__init__.py +0 -0
  251. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkreprrawrendered/metadata.toml +0 -0
  252. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkshields/__init__.py +0 -0
  253. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mkshields/metadata.toml +0 -0
  254. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mktemplate/__init__.py +0 -0
  255. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mktemplate/metadata.toml +0 -0
  256. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mktemplatetable/__init__.py +0 -0
  257. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mktemplatetable/metadata.toml +0 -0
  258. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/templatenodes/mktreeview/__init__.py +0 -0
  259. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/theme/__init__.py +0 -0
  260. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/theme/colortheme.py +0 -0
  261. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/theme/materialtheme/__init__.py +0 -0
  262. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/theme/materialtheme/palette.py +0 -0
  263. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/theme/mkblog.py +0 -0
  264. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/theme/mkgitblog.py +0 -0
  265. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/treelib/__init__.py +0 -0
  266. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/treelib/treeprint.py +0 -0
  267. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/__init__.py +0 -0
  268. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/annotationappender.py +0 -0
  269. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/classhelpers.py +0 -0
  270. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/color.py +0 -0
  271. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/connector.py +0 -0
  272. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/coroutines.py +0 -0
  273. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/downloadhelpers.py +0 -0
  274. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/helpers.py +0 -0
  275. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/icons.py +0 -0
  276. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/inspecthelpers.py +0 -0
  277. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/inventorymanager.py +0 -0
  278. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/linkreplacer.py +0 -0
  279. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/log.py +0 -0
  280. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/packagehelpers.py +0 -0
  281. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/pathhelpers.py +0 -0
  282. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/reprhelpers.py +0 -0
  283. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/resources.py +0 -0
  284. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/superdict.py +0 -0
  285. {mknodes-2.0.0/src → mknodes-2.0.0a4}/mknodes/utils/xmlhelpers.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: mknodes
3
- Version: 2.0.0
3
+ Version: 2.0.0a4
4
4
  Summary: Don't write docs. Code them.
5
5
  Keywords: docs,docstrings,documentation,framework,internet,markdown
6
6
  Author: Philipp Temminghoff
@@ -64,7 +64,6 @@ Requires-Dist: pytest-asyncio>=1.3.0
64
64
  Requires-Dist: python-dotenv
65
65
  Requires-Dist: setuptools>=80.9.0
66
66
  Requires-Dist: tomli-w
67
- Requires-Dist: typer>=0.12.0
68
67
  Requires-Dist: universal-pathlib
69
68
  Requires-Dist: upathtools[httpx]
70
69
  Requires-Dist: yamling
@@ -56,8 +56,6 @@ 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
-
61
59
  from .templatenodes.mkinclude import MkInclude
62
60
  from .templatenodes.mkshields import MkShields
63
61
  from .templatenodes.mkinstallguide import MkInstallGuide
@@ -107,9 +105,6 @@ async def parse(project=None, **kwargs):
107
105
  __version__ = version("mknodes")
108
106
 
109
107
  __all__ = [
110
- "BuildOutput",
111
- "DocBuilder",
112
- "MarkdownExporter",
113
108
  "MaterialTheme",
114
109
  "Metadata",
115
110
  "MkAdmonition",
@@ -124,6 +119,7 @@ __all__ = [
124
119
  "MkClassPage",
125
120
  "MkClassTable",
126
121
  "MkCliDoc",
122
+ # "MkGrid",
127
123
  "MkCode",
128
124
  "MkCodeOfConduct",
129
125
  "MkCommandOutput",
@@ -459,5 +459,5 @@ async def parse_new_style_nav(
459
459
  if __name__ == "__main__":
460
460
  log.basic()
461
461
  nav = mknav.MkNav()
462
- nav.parse.module("mknodes/src/manual/")
462
+ nav.parse.module("mknodes/manual/")
463
463
  print(nav)
@@ -71,13 +71,13 @@ class MkLlm(mktext.MkText):
71
71
  context_items: list[str] = []
72
72
 
73
73
  def process_dir(path: UPath) -> list[str]:
74
- return [f.read_text("utf-8") for f in path.rglob("*") if f.is_file()]
74
+ return [f.read_text() for f in path.rglob("*") if f.is_file()]
75
75
 
76
76
  for item in self._extra_files:
77
77
  try:
78
78
  path = to_upath(item)
79
79
  if path.is_file():
80
- context_items.append(path.read_text("utf-8"))
80
+ context_items.append(path.read_text())
81
81
  elif path.is_dir():
82
82
  context_items.extend(process_dir(path))
83
83
  else:
@@ -123,5 +123,5 @@ class MkPyDeps(mknode.MkNode):
123
123
 
124
124
 
125
125
  if __name__ == "__main__":
126
- node = MkPyDeps.with_context("src/mknodes/data/tools.py", max_bacon=1)
126
+ node = MkPyDeps.with_context("mknodes/data/tools.py", max_bacon=1)
127
127
  print(node)
@@ -5,31 +5,31 @@ name = "MkTreeView"
5
5
  [examples.regular]
6
6
  title = "Different styles"
7
7
  jinja = """
8
- {{ "src/mknodes/manual" | MkTreeView }}
8
+ {{ "mknodes/manual" | MkTreeView }}
9
9
  """
10
10
 
11
11
  [examples.ansi]
12
12
  title = "Style 'ansi'"
13
13
  jinja = """
14
- {{ "src/mknodes/manual" | MkTreeView(style="ansi") }}
14
+ {{ "mknodes/manual" | MkTreeView(style="ansi") }}
15
15
  """
16
16
 
17
17
  [examples.ascii]
18
18
  title = "Style 'ascii'"
19
19
  jinja = """
20
- {{ "src/mknodes/manual" | MkTreeView(style="ascii") }}
20
+ {{ "mknodes/manual" | MkTreeView(style="ascii") }}
21
21
  """
22
22
 
23
23
  [examples.rounded]
24
24
  title = "Style 'rounded'"
25
25
  jinja = """
26
- {{ "src/mknodes/manual" | MkTreeView(style="rounded") }}
26
+ {{ "mknodes/manual" | MkTreeView(style="rounded") }}
27
27
  """
28
28
 
29
29
  [examples.spaces]
30
30
  title = "Style 'spaces'"
31
31
  jinja = """
32
- {{ "src/mknodes/manual" | MkTreeView(style="spaces") }}
32
+ {{ "mknodes/manual" | MkTreeView(style="spaces") }}
33
33
  """
34
34
 
35
35
  # [examples.remote]
@@ -39,7 +39,7 @@ class Theme:
39
39
  self.data = data or {}
40
40
  self.features = self.data.get("features")
41
41
  loader = jinjarope.registry.get_package_loader("mknodes.resources")
42
- self.env = jinjarope.Environment(loader=loader, enable_async=True)
42
+ self.env = jinjarope.Environment(loader=loader)
43
43
  self.templates = templateregistry.TemplateRegistry()
44
44
  self.main_template = self.templates["main.html"]
45
45
  self.error_page = self.templates["404.html"]
@@ -2,7 +2,7 @@
2
2
 
3
3
  [project]
4
4
  name = "mknodes"
5
- version = "2.0.0"
5
+ version = "2.0.0a4"
6
6
  description = "Don't write docs. Code them."
7
7
  readme = "README.md"
8
8
  requires-python = ">=3.13"
@@ -63,7 +63,6 @@ dependencies = [
63
63
  # Serialization
64
64
  "setuptools>=80.9.0",
65
65
  "tomli-w",
66
- "typer>=0.12.0",
67
66
  "universal_pathlib",
68
67
  "upathtools[httpx]",
69
68
  "yamling",
@@ -74,9 +73,6 @@ dependencies = [
74
73
  Documentation = "https://phil65.github.io/mknodes/"
75
74
  Source = "https://github.com/phil65/mknodes"
76
75
 
77
- [project.scripts]
78
- mknodes = "mknodes.cli:main"
79
-
80
76
  [project.entry-points."jinjarope.environment"]
81
77
  mknodes = "mknodes.jinja:setup_env"
82
78
 
@@ -307,3 +303,6 @@ combine-as-imports = true
307
303
  # Enable preview style formatting.
308
304
  preview = true
309
305
  docstring-code-format = true
306
+
307
+ [tool.uv.build-backend]
308
+ module-root = ""
@@ -1,7 +0,0 @@
1
- """Entry point for `python -m mknodes`."""
2
-
3
- from mknodes.cli import main
4
-
5
-
6
- if __name__ == "__main__":
7
- main()
@@ -1,10 +0,0 @@
1
- """Build module for generating documentation output."""
2
-
3
- from __future__ import annotations
4
-
5
- from mknodes.build.builder import DocBuilder
6
- from mknodes.build.exporter import Exporter, MarkdownExporter
7
- from mknodes.build.output import BuildOutput
8
-
9
-
10
- __all__ = ["BuildOutput", "DocBuilder", "Exporter", "MarkdownExporter"]
@@ -1,110 +0,0 @@
1
- """Core documentation builder."""
2
-
3
- from __future__ import annotations
4
-
5
- from typing import TYPE_CHECKING
6
-
7
- from mknodes.utils import log, resources
8
-
9
-
10
- if TYPE_CHECKING:
11
- import mknodes as mk
12
-
13
- from .output import BuildOutput
14
-
15
-
16
- logger = log.get_logger(__name__)
17
-
18
-
19
- class DocBuilder:
20
- """Traverses node tree, renders markdown, collects resources."""
21
-
22
- def __init__(self, render_jinja: bool = True):
23
- """Constructor.
24
-
25
- Args:
26
- render_jinja: Whether to render Jinja templates in pages.
27
- """
28
- self.render_jinja = render_jinja
29
- self._files: dict[str, str | bytes] = {}
30
- self._resources = resources.Resources()
31
-
32
- async def build(self, root: mk.MkNav) -> BuildOutput:
33
- """Build documentation from a navigation tree.
34
-
35
- Args:
36
- root: Root navigation node to build from.
37
-
38
- Returns:
39
- BuildOutput containing all files and collected resources.
40
- """
41
- import mknodes as mk
42
- from mknodes.build.output import BuildOutput
43
-
44
- logger.info("Starting documentation build...")
45
-
46
- page_count = 0
47
-
48
- # First pass: collect all pages and navs
49
- for _level, node in root.iter_nodes():
50
- self._files |= node.files
51
-
52
- match node:
53
- case mk.MkPage() as page:
54
- await self._process_page(page)
55
- page_count += 1
56
- case mk.MkNav() as nav:
57
- await self._process_nav(nav)
58
-
59
- # Build nav structure
60
- nav_structure = root.nav.to_nav_dict()
61
-
62
- return BuildOutput(
63
- files=self._files,
64
- resources=self._resources,
65
- nav_structure=nav_structure,
66
- page_count=page_count,
67
- )
68
-
69
- async def _process_page(self, page: mk.MkPage) -> None:
70
- """Process a single page: render and collect resources.
71
-
72
- Args:
73
- page: Page to process.
74
- """
75
- if page.resolved_metadata.inclusion_level is False:
76
- return
77
-
78
- path = page.resolved_file_path
79
- logger.debug("Processing page: %s", path)
80
-
81
- # Collect resources
82
- req = await page.get_resources()
83
- self._resources.merge(req)
84
-
85
- # Render markdown
86
- md = await page.to_markdown()
87
-
88
- if self.render_jinja:
89
- render = page.metadata.get("render_macros", True)
90
- if render:
91
- md = await page.env.render_string_async(md)
92
-
93
- self._files[path] = md
94
-
95
- async def _process_nav(self, nav: mk.MkNav) -> None:
96
- """Process a navigation section.
97
-
98
- Args:
99
- nav: Navigation to process.
100
- """
101
- path = nav.resolved_file_path
102
- logger.debug("Processing nav: %s", nav.title or "[ROOT]")
103
-
104
- # Collect resources
105
- req = await nav.get_node_resources()
106
- self._resources.merge(req)
107
-
108
- # Render nav markdown (SUMMARY.md style)
109
- md = await nav.to_markdown()
110
- self._files[path] = md
@@ -1,168 +0,0 @@
1
- """Exporters for writing build output to disk."""
2
-
3
- from __future__ import annotations
4
-
5
- import json
6
- from typing import TYPE_CHECKING, Any, Protocol
7
-
8
- import upath
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.json"):
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
-
56
- # Write metadata sidecar
57
- metadata = self._build_file_metadata(file_path, output)
58
- if metadata:
59
- meta_path = full_path.with_suffix(full_path.suffix + self.metadata_suffix)
60
- meta_path.write_text(
61
- json.dumps(metadata, indent=2, default=str),
62
- encoding="utf-8",
63
- )
64
-
65
- # Write global resources file
66
- if output.resources:
67
- resources_path = target_path / ".mknodes.resources.json"
68
- resources_path.write_text(
69
- json.dumps(self._serialize_resources(output.resources), indent=2),
70
- encoding="utf-8",
71
- )
72
-
73
- # Write nav structure
74
- if output.nav_structure:
75
- nav_path = target_path / ".mknodes.nav.json"
76
- nav_path.write_text(
77
- json.dumps(output.nav_structure, indent=2),
78
- encoding="utf-8",
79
- )
80
-
81
- def _build_file_metadata(
82
- self,
83
- file_path: str,
84
- output: BuildOutput,
85
- ) -> dict[str, Any]:
86
- """Build metadata dict for a single file.
87
-
88
- Args:
89
- file_path: Path of the file.
90
- output: Full build output for context.
91
-
92
- Returns:
93
- Metadata dictionary for the file.
94
- """
95
- # For now, just mark that this file was generated
96
- return {"generated_by": "mknodes", "path": file_path}
97
-
98
- def _serialize_resources(self, resources) -> dict[str, Any]:
99
- """Serialize Resources object to JSON-compatible dict.
100
-
101
- Args:
102
- resources: Resources object to serialize.
103
-
104
- Returns:
105
- JSON-serializable dictionary.
106
- """
107
- return {
108
- "markdown_extensions": self._serialize_extensions(resources.markdown_extensions),
109
- "css": [self._serialize_css(c) for c in resources.css],
110
- "js": [self._serialize_js(j) for j in resources.js],
111
- "plugins": [p.plugin_name for p in resources.plugins],
112
- "packages": [p.package_name for p in resources.packages],
113
- }
114
-
115
- def _serialize_extensions(self, extensions: dict[str, Any]) -> dict[str, Any]:
116
- """Serialize markdown extensions, handling non-serializable values.
117
-
118
- Args:
119
- extensions: Extension configuration dict.
120
-
121
- Returns:
122
- JSON-serializable dictionary.
123
- """
124
- result = {}
125
- for ext_name, ext_config in extensions.items():
126
- if isinstance(ext_config, dict):
127
- serialized_config = {}
128
- for k, v in ext_config.items():
129
- if callable(v):
130
- # Store function reference as string
131
- serialized_config[k] = f"{v.__module__}:{v.__name__}"
132
- else:
133
- try:
134
- json.dumps(v)
135
- serialized_config[k] = v
136
- except (TypeError, ValueError):
137
- serialized_config[k] = str(v)
138
- result[ext_name] = serialized_config
139
- else:
140
- result[ext_name] = ext_config
141
- return result
142
-
143
- def _serialize_css(self, css) -> dict[str, Any]:
144
- """Serialize CSS resource."""
145
- from mknodes.utils.resources import CSSFile
146
-
147
- if isinstance(css, CSSFile):
148
- return {"type": "link", "link": css.link}
149
- return {"type": "text", "filename": css.filename, "content": css.content}
150
-
151
- def _serialize_js(self, js) -> dict[str, Any]:
152
- """Serialize JS resource."""
153
- from mknodes.utils.resources import JSFile
154
-
155
- if isinstance(js, JSFile):
156
- return {
157
- "type": "link",
158
- "link": js.link,
159
- "async": js.async_,
160
- "defer": js.defer,
161
- "is_library": js.is_library,
162
- }
163
- return {
164
- "type": "text",
165
- "filename": js.filename,
166
- "content": js.content,
167
- "is_library": js.is_library,
168
- }
@@ -1,30 +0,0 @@
1
- """Build output types."""
2
-
3
- from __future__ import annotations
4
-
5
- import dataclasses
6
- from typing import TYPE_CHECKING, Any
7
-
8
-
9
- if TYPE_CHECKING:
10
- from mknodes.utils import resources as res
11
-
12
-
13
- @dataclasses.dataclass
14
- class BuildOutput:
15
- """Result of building a documentation tree."""
16
-
17
- files: dict[str, str | bytes] = dataclasses.field(default_factory=dict)
18
- """Mapping of file paths to markdown/content."""
19
-
20
- resources: res.Resources | None = None
21
- """Collected resources (JS, CSS, extensions)."""
22
-
23
- nav_structure: dict[str, Any] = dataclasses.field(default_factory=dict)
24
- """Navigation structure for downstream consumers."""
25
-
26
- page_count: int = 0
27
- """Number of pages built."""
28
-
29
- def __repr__(self) -> str:
30
- return f"{type(self).__name__}(files={len(self.files)}, pages={self.page_count})"
@@ -1,164 +0,0 @@
1
- """MkNodes CLI interface."""
2
-
3
- from __future__ import annotations
4
-
5
- import asyncio
6
- import logging
7
- import sys
8
- from pathlib import Path
9
-
10
- import typer as t
11
-
12
- from mknodes.utils import classhelpers, log
13
-
14
-
15
- logger = log.get_logger(__name__)
16
-
17
- cli = t.Typer(
18
- name="mknodes",
19
- help="MkNodes CLI - Generate markdown documentation from Python code.",
20
- no_args_is_help=True,
21
- )
22
-
23
-
24
- SCRIPT_HELP = "Path to build script (format: `path.to.module:function`)."
25
- OUTPUT_HELP = "Output directory for generated markdown files."
26
- REPO_HELP = "Repository URL or local path for context."
27
- RENDER_JINJA_HELP = "Render Jinja templates in pages."
28
- VERBOSE_HELP = "Enable verbose output (DEBUG level)."
29
- QUIET_HELP = "Suppress output during build."
30
- INPUT_HELP = "Input markdown file to render (use - for stdin)."
31
- OUTPUT_FILE_HELP = "Output file (use - for stdout, default)."
32
-
33
- SCRIPT_CMDS = "-s", "--script"
34
- OUTPUT_CMDS = "-o", "--output"
35
- REPO_CMDS = "-r", "--repo-url"
36
- VERBOSE_CMDS = "-v", "--verbose"
37
- QUIET_CMDS = "-q", "--quiet"
38
- INPUT_CMDS = "-i", "--input"
39
- OUTPUT_FILE_CMDS = "-o", "--output"
40
-
41
-
42
- def verbose_callback(ctx: t.Context, _param: t.CallbackParam, value: bool):
43
- if value:
44
- logging.getLogger("mknodes").setLevel(logging.DEBUG)
45
-
46
-
47
- def quiet_callback(ctx: t.Context, _param: t.CallbackParam, value: bool):
48
- if value:
49
- logging.getLogger("mknodes").setLevel(logging.ERROR)
50
-
51
-
52
- @cli.command()
53
- def build(
54
- script: str = t.Option(..., *SCRIPT_CMDS, help=SCRIPT_HELP),
55
- output: Path = t.Option(Path("docs"), *OUTPUT_CMDS, help=OUTPUT_HELP), # noqa: B008
56
- repo_url: str | None = t.Option(None, *REPO_CMDS, help=REPO_HELP, show_default=False),
57
- render_jinja: bool = t.Option(True, "--render-jinja/--no-render-jinja", help=RENDER_JINJA_HELP),
58
- _verbose: bool = t.Option(False, *VERBOSE_CMDS, help=VERBOSE_HELP, callback=verbose_callback),
59
- _quiet: bool = t.Option(False, *QUIET_CMDS, help=QUIET_HELP, callback=quiet_callback),
60
- ) -> None:
61
- """Build markdown documentation from a build script.
62
-
63
- The build script should be a function that takes a root MkNav and populates it.
64
-
65
- Example:
66
- mknodes build -s mypackage.docs:build -o ./docs
67
- """
68
- asyncio.run(_build_async(script, output, repo_url, render_jinja))
69
-
70
-
71
- async def _build_async(script: str, output: Path, repo_url: str | None, render_jinja: bool) -> None:
72
- """Async implementation of build command."""
73
- import mknodes as mk
74
- from mknodes.build import DocBuilder, MarkdownExporter
75
-
76
- logger.info("Loading build script: %s", script)
77
- build_fn = classhelpers.to_callable(script)
78
-
79
- # Create root nav with optional repo context
80
- root = mk.MkNav.with_context(repo_url=repo_url) if repo_url else mk.MkNav()
81
-
82
- logger.info("Executing build script...")
83
- result = build_fn(root)
84
-
85
- # Handle both styles: function modifies root in-place, or returns new nav
86
- if result is not None:
87
- root = result
88
-
89
- logger.info("Building documentation tree...")
90
- builder = DocBuilder(render_jinja=render_jinja)
91
- build_output = await builder.build(root)
92
-
93
- logger.info("Exporting to %s...", output)
94
- exporter = MarkdownExporter()
95
- await exporter.export(build_output, output)
96
-
97
- logger.info(
98
- "Build complete: %d files, %d pages",
99
- len(build_output.files),
100
- build_output.page_count,
101
- )
102
-
103
-
104
- @cli.command()
105
- def render(
106
- input_file: str = t.Option(..., *INPUT_CMDS, help=INPUT_HELP),
107
- output_file: str = t.Option("-", *OUTPUT_FILE_CMDS, help=OUTPUT_FILE_HELP),
108
- repo_url: str | None = t.Option(None, *REPO_CMDS, help=REPO_HELP, show_default=False),
109
- _verbose: bool = t.Option(False, *VERBOSE_CMDS, help=VERBOSE_HELP, callback=verbose_callback),
110
- _quiet: bool = t.Option(False, *QUIET_CMDS, help=QUIET_HELP, callback=quiet_callback),
111
- ) -> None:
112
- """Render a single markdown file with Jinja macros.
113
-
114
- Reads markdown content, processes Jinja templates, and outputs the result.
115
-
116
- Example:
117
- mknodes render -i template.md -o output.md
118
- cat template.md | mknodes render -i - > output.md
119
- """
120
- asyncio.run(_render_async(input_file, output_file, repo_url))
121
-
122
-
123
- async def _render_async(input_file: str, output_file: str, repo_url: str | None) -> None:
124
- """Async implementation of render command."""
125
- import mknodes as mk
126
- from mknodes.jinja import nodeenvironment
127
-
128
- # Read input
129
- if input_file == "-":
130
- content = sys.stdin.read()
131
- else:
132
- path = Path(input_file)
133
- if not path.exists():
134
- logger.error("Input file not found: %s", input_file)
135
- raise SystemExit(1)
136
- content = path.read_text(encoding="utf-8")
137
-
138
- logger.info("Rendering markdown with Jinja macros...")
139
-
140
- # Create a page to hold the content and provide context
141
- nav = mk.MkNav.with_context(repo_url=repo_url) if repo_url else mk.MkNav()
142
-
143
- page = nav.add_page("render", is_index=True)
144
- env = nodeenvironment.NodeEnvironment(node=page)
145
-
146
- # Render the content
147
- rendered = await env.render_string_async(content)
148
-
149
- # Write output
150
- if output_file == "-":
151
- sys.stdout.write(rendered)
152
- else:
153
- Path(output_file).write_text(rendered, encoding="utf-8")
154
- logger.info("Rendered output written to: %s", output_file)
155
-
156
-
157
- def main() -> None:
158
- """Entry point for CLI."""
159
- log.basic()
160
- cli()
161
-
162
-
163
- if __name__ == "__main__":
164
- main()