mknodes 2.0.4__tar.gz → 2.0.6__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 (287) hide show
  1. {mknodes-2.0.4 → mknodes-2.0.6}/PKG-INFO +1 -1
  2. {mknodes-2.0.4 → mknodes-2.0.6}/pyproject.toml +1 -1
  3. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/nodefile.py +0 -1
  4. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/packageinfo.py +0 -1
  5. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/jinja/filters.py +6 -2
  6. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkcommentedcode/__init__.py +40 -0
  7. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkcommentedcode/metadata.toml +1 -3
  8. mknodes-2.0.6/src/mknodes/utils/downloadhelpers.py +33 -0
  9. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/icons.py +1 -6
  10. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/inspecthelpers.py +1 -41
  11. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/inventorymanager.py +22 -29
  12. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/log.py +0 -4
  13. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/packagehelpers.py +0 -11
  14. mknodes-2.0.6/src/mknodes/utils/pathhelpers.py +49 -0
  15. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/superdict.py +3 -2
  16. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/xmlhelpers.py +1 -16
  17. mknodes-2.0.4/src/mknodes/theme/mkblog.py +0 -182
  18. mknodes-2.0.4/src/mknodes/theme/mkgitblog.py +0 -128
  19. mknodes-2.0.4/src/mknodes/utils/downloadhelpers.py +0 -68
  20. mknodes-2.0.4/src/mknodes/utils/pathhelpers.py +0 -133
  21. {mknodes-2.0.4 → mknodes-2.0.6}/LICENSE +0 -0
  22. {mknodes-2.0.4 → mknodes-2.0.6}/README.md +0 -0
  23. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/__init__.py +0 -0
  24. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/__main__.py +0 -0
  25. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/__init__.py +0 -0
  26. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/_mkdocstrings/__init__.py +0 -0
  27. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/_mkdocstrings/metadata.toml +0 -0
  28. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkadmonition/__init__.py +0 -0
  29. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkadmonition/metadata.toml +0 -0
  30. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkannotations/__init__.py +0 -0
  31. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkannotations/metadata.toml +0 -0
  32. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkbasetable/__init__.py +0 -0
  33. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkbinaryimage/__init__.py +0 -0
  34. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkbinaryimage/metadata.toml +0 -0
  35. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkblock/__init__.py +0 -0
  36. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkblockquote/__init__.py +0 -0
  37. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkblockquote/metadata.toml +0 -0
  38. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkcard/__init__.py +0 -0
  39. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkcard/grid.css +0 -0
  40. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkcard/metadata.toml +0 -0
  41. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkclidoc/__init__.py +0 -0
  42. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkclidoc/metadata.toml +0 -0
  43. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkcode/__init__.py +0 -0
  44. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkcode/metadata.toml +0 -0
  45. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkcompactadmonition/__init__.py +0 -0
  46. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkcompactadmonition/compactadmonition.css +0 -0
  47. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkcompactadmonition/metadata.toml +0 -0
  48. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkcontainer/__init__.py +0 -0
  49. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkcontainer/metadata.toml +0 -0
  50. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkcritic/__init__.py +0 -0
  51. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkcritic/metadata.toml +0 -0
  52. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkdataclassinfo/__init__.py +0 -0
  53. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkdataclassinfo/metadata.toml +0 -0
  54. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkdefinitionlist/__init__.py +0 -0
  55. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkdefinitionlist/metadata.toml +0 -0
  56. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkdetailsblock/__init__.py +0 -0
  57. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkdetailsblock/metadata.toml +0 -0
  58. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkdiagram/__init__.py +0 -0
  59. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkdiagram/metadata.toml +0 -0
  60. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkfootnotes/__init__.py +0 -0
  61. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkfootnotes/metadata.toml +0 -0
  62. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkheader/__init__.py +0 -0
  63. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkheader/metadata.toml +0 -0
  64. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkhtmlblock/__init__.py +0 -0
  65. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkhtmlblock/metadata.toml +0 -0
  66. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkhtmltable/__init__.py +0 -0
  67. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkhtmltable/metadata.toml +0 -0
  68. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkicon/__init__.py +0 -0
  69. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkicon/metadata.toml +0 -0
  70. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkiframe/__init__.py +0 -0
  71. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkiframe/metadata.toml +0 -0
  72. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkimage/__init__.py +0 -0
  73. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkimage/metadata.toml +0 -0
  74. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkimagecompare/__init__.py +0 -0
  75. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkimagecompare/metadata.toml +0 -0
  76. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkimageslideshow/__init__.py +0 -0
  77. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkimageslideshow/metadata.toml +0 -0
  78. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkjupyterlite/__init__.py +0 -0
  79. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkjupyterlite/metadata.toml +0 -0
  80. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkkeys/__init__.py +0 -0
  81. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkkeys/metadata.toml +0 -0
  82. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mklink/__init__.py +0 -0
  83. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mklink/metadata.toml +0 -0
  84. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mklist/__init__.py +0 -0
  85. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mklist/metadata.toml +0 -0
  86. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkmaterialbadge/__init__.py +0 -0
  87. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkmaterialbadge/materialbadge.css +0 -0
  88. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkmaterialbadge/metadata.toml +0 -0
  89. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mknode/__init__.py +0 -0
  90. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkprogressbar/__init__.py +0 -0
  91. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkprogressbar/metadata.toml +0 -0
  92. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkprogressbar/progressbar.css +0 -0
  93. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkpyodide/__init__.py +0 -0
  94. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkpyodide/metadata.toml +0 -0
  95. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkpyscript/__init__.py +0 -0
  96. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkpyscript/metadata.toml +0 -0
  97. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkshowcase/__init__.py +0 -0
  98. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkshowcase/metadata.toml +0 -0
  99. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkspeechbubble/__init__.py +0 -0
  100. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkspeechbubble/metadata.toml +0 -0
  101. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mkspeechbubble/speechbubble.css +0 -0
  102. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktabbed/__init__.py +0 -0
  103. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktabbed/metadata.toml +0 -0
  104. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktabbedblocks/__init__.py +0 -0
  105. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktabbedblocks/metadata.toml +0 -0
  106. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktabcontainer.py +0 -0
  107. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktable/__init__.py +0 -0
  108. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktable/metadata.toml +0 -0
  109. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktabs/__init__.py +0 -0
  110. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktabs/mktab.toml +0 -0
  111. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktasklist/__init__.py +0 -0
  112. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktasklist/metadata.toml +0 -0
  113. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktext/__init__.py +0 -0
  114. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktext/metadata.toml +0 -0
  115. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktimeline/__init__.py +0 -0
  116. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktimeline/metadata.toml +0 -0
  117. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktimeline/timeline.css +0 -0
  118. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/mktimeline/timeline.js +0 -0
  119. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/basenodes/processors/__init__.py +0 -0
  120. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/build/__init__.py +0 -0
  121. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/build/builder.py +0 -0
  122. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/build/exporter.py +0 -0
  123. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/build/output.py +0 -0
  124. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/cli/__init__.py +0 -0
  125. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/data/__init__.py +0 -0
  126. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/data/admonition.py +0 -0
  127. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/data/badges.py +0 -0
  128. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/data/buildsystems.py +0 -0
  129. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/data/commitconventions.py +0 -0
  130. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/data/datatypes.py +0 -0
  131. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/data/eventplugins.py +0 -0
  132. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/data/fences.py +0 -0
  133. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/data/installmethods.py +0 -0
  134. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/data/taskrunners.py +0 -0
  135. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/data/tools.py +0 -0
  136. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/data/treestyles.py +0 -0
  137. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/extranodes/__init__.py +0 -0
  138. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/extranodes/mkcodeimage/__init__.py +0 -0
  139. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/extranodes/mkcodeimage/metadata.toml +0 -0
  140. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/extranodes/mkgrid/__init__.py +0 -0
  141. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/extranodes/mkgrid/metadata.toml +0 -0
  142. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/extranodes/mkprettyprint/__init__.py +0 -0
  143. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/extranodes/mkprettyprint/metadata.toml +0 -0
  144. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/extranodes/mksnippet/__init__.py +0 -0
  145. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/extranodes/mksnippet/metadata.toml +0 -0
  146. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/__init__.py +0 -0
  147. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/configfile.py +0 -0
  148. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/contexts.py +0 -0
  149. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/folderinfo.py +0 -0
  150. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/gitrepository.py +0 -0
  151. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/grifferegistry.py +0 -0
  152. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/license.py +0 -0
  153. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/linkprovider.py +0 -0
  154. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/mkdocsconfigfile.py +0 -0
  155. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/packageregistry.py +0 -0
  156. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/pyproject.py +0 -0
  157. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/info/reporegistry.py +0 -0
  158. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/jinja/__init__.py +0 -0
  159. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/jinja/nodeenvironment.py +0 -0
  160. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/manual/__init__.py +0 -0
  161. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/manual/a_quick_tour.py +0 -0
  162. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/manual/dev_section.py +0 -0
  163. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/manual/get_started_section.py +0 -0
  164. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/manual/github_index.py +0 -0
  165. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/manual/navs_section.py +0 -0
  166. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/manual/nodes_section.py +0 -0
  167. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/manual/page_section.py +0 -0
  168. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/manual/root.py +0 -0
  169. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/manual/routing.py +0 -0
  170. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/manual/standalone.py +0 -0
  171. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/manual/templating_section.py +0 -0
  172. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/mdlib/__init__.py +0 -0
  173. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/mdlib/mdconverter.py +0 -0
  174. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/navs/__init__.py +0 -0
  175. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/navs/mkdoc.py +0 -0
  176. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/navs/mknav.py +0 -0
  177. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/navs/navbuilder.py +0 -0
  178. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/navs/navigation.py +0 -0
  179. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/navs/navparser.py +0 -0
  180. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/navs/navrouter.py +0 -0
  181. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/navs/router.py +0 -0
  182. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/nodemods/__init__.py +0 -0
  183. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/nodemods/mod.py +0 -0
  184. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/nodemods/modmanager.py +0 -0
  185. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/nodemods/parallax.py +0 -0
  186. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/nodemods/parallax.toml +0 -0
  187. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/nodemods/scrollreveal.py +0 -0
  188. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/nodemods/scrollreveal.toml +0 -0
  189. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/__init__.py +0 -0
  190. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/metadata.py +0 -0
  191. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/mkclasspage/__init__.py +0 -0
  192. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/mkclasspage/classpage.md +0 -0
  193. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/mkclasspage/classpage_tabbed.md +0 -0
  194. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/mkmodulepage/__init__.py +0 -0
  195. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/mkmodulepage/modulepage.md +0 -0
  196. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/mkpage.py +0 -0
  197. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/mktemplatepage.py +0 -0
  198. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/pagetemplate.py +0 -0
  199. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/templateblocks.py +0 -0
  200. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/templateregistry.py +0 -0
  201. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/pages/toc.py +0 -0
  202. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/paths.py +0 -0
  203. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/py.typed +0 -0
  204. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/css/animated.css +0 -0
  205. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/css/hero.css +0 -0
  206. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/css/material_css_extra.jinja +0 -0
  207. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/css/theme_material.css +0 -0
  208. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/css/theme_mkdocs.css +0 -0
  209. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/filters.toml +0 -0
  210. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/js/tablesort.js +0 -0
  211. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/python_objects.inv +0 -0
  212. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/toolfiles/tool_black.toml +0 -0
  213. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/toolfiles/tool_coverage.toml +0 -0
  214. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/toolfiles/tool_mkdocs.toml +0 -0
  215. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/toolfiles/tool_mypy.toml +0 -0
  216. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/toolfiles/tool_precommit.toml +0 -0
  217. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/toolfiles/tool_pyright.toml +0 -0
  218. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/resources/toolfiles/tool_ruff.toml +0 -0
  219. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/__init__.py +0 -0
  220. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkbadge/__init__.py +0 -0
  221. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkbadge/metadata.toml +0 -0
  222. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkchangelog/__init__.py +0 -0
  223. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkchangelog/metadata.toml +0 -0
  224. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkclassdiagram/__init__.py +0 -0
  225. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkclassdiagram/metadata.toml +0 -0
  226. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkclasstable/__init__.py +0 -0
  227. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkclasstable/metadata.toml +0 -0
  228. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkcodeofconduct/__init__.py +0 -0
  229. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkcodeofconduct/metadata.toml +0 -0
  230. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkcommandoutput/__init__.py +0 -0
  231. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkcommandoutput/metadata.toml +0 -0
  232. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkcommandoutput/terminal.css +0 -0
  233. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkcommitconventions/__init__.py +0 -0
  234. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkcommitconventions/metadata.toml +0 -0
  235. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkconfigsetting/__init__.py +0 -0
  236. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkconfigsetting/metadata.toml +0 -0
  237. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkdependencytable/__init__.py +0 -0
  238. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkdependencytable/metadata.toml +0 -0
  239. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkdevenvsetup/__init__.py +0 -0
  240. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkdevenvsetup/metadata.toml +0 -0
  241. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkdevtools/__init__.py +0 -0
  242. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkdevtools/metadata.toml +0 -0
  243. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkinclude/__init__.py +0 -0
  244. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkinclude/metadata.toml +0 -0
  245. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkinstallguide/__init__.py +0 -0
  246. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkinstallguide/metadata.toml +0 -0
  247. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mklicense/__init__.py +0 -0
  248. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mklicense/metadata.toml +0 -0
  249. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkllm/__init__.py +0 -0
  250. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkllm/metadata.toml +0 -0
  251. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkmetadatabadges/__init__.py +0 -0
  252. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkmetadatabadges/metadata.toml +0 -0
  253. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkmoduletable/__init__.py +0 -0
  254. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkmoduletable/metadata.toml +0 -0
  255. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkpipdeptree/__init__.py +0 -0
  256. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkpipdeptree/metadata.toml +0 -0
  257. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkpluginflow/__init__.py +0 -0
  258. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkpluginflow/metadata.toml +0 -0
  259. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkpydeps/__init__.py +0 -0
  260. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkpydeps/metadata.toml +0 -0
  261. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkreprrawrendered/__init__.py +0 -0
  262. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkreprrawrendered/metadata.toml +0 -0
  263. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkshields/__init__.py +0 -0
  264. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mkshields/metadata.toml +0 -0
  265. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mktemplate/__init__.py +0 -0
  266. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mktemplate/metadata.toml +0 -0
  267. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mktemplatetable/__init__.py +0 -0
  268. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mktemplatetable/metadata.toml +0 -0
  269. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mktreeview/__init__.py +0 -0
  270. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/templatenodes/mktreeview/metadata.toml +0 -0
  271. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/theme/__init__.py +0 -0
  272. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/theme/colortheme.py +0 -0
  273. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/theme/materialtheme/__init__.py +0 -0
  274. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/theme/materialtheme/palette.py +0 -0
  275. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/theme/theme.py +0 -0
  276. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/treelib/__init__.py +0 -0
  277. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/treelib/treeprint.py +0 -0
  278. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/__init__.py +0 -0
  279. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/annotationappender.py +0 -0
  280. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/classhelpers.py +0 -0
  281. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/color.py +0 -0
  282. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/connector.py +0 -0
  283. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/coroutines.py +0 -0
  284. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/helpers.py +0 -0
  285. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/linkreplacer.py +0 -0
  286. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/reprhelpers.py +0 -0
  287. {mknodes-2.0.4 → mknodes-2.0.6}/src/mknodes/utils/resources.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: mknodes
3
- Version: 2.0.4
3
+ Version: 2.0.6
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.4"
5
+ version = "2.0.6"
6
6
  description = "Don't write docs. Code them."
7
7
  readme = "README.md"
8
8
  requires-python = ">=3.13"
@@ -46,7 +46,6 @@ def get_nodefile(klass: type) -> NodeFile | None:
46
46
  def find_file(klass: type) -> pathlib.Path | None:
47
47
  path = inspectfilters.get_file(klass) # type: ignore[arg-type]
48
48
  assert path
49
- # text = pathhelpers.load_file_cached(path.parent / "metadata.toml")
50
49
  if (file := path.parent / f"{klass.__name__}.toml").exists():
51
50
  return file
52
51
  if (file := path.parent / f"{klass.__name__}.toml".lower()).exists():
@@ -212,7 +212,6 @@ class PackageInfo:
212
212
  @functools.cached_property
213
213
  def entry_points(self) -> epregistry.ModuleEntryPointRegistry[Any]:
214
214
  """Get entry points for this package."""
215
- # just using distribution.entry_points might be alternative, but is uncached afaik
216
215
  name = epregistry.distribution_to_package(self.package_name)
217
216
  return epregistry.ModuleEntryPointRegistry(name)
218
217
 
@@ -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: # pyright: ignore[reportAttributeAccessIssue]
127
131
  html += ' type="{1.type}"' # type or typ?
128
132
  if extra_script.defer:
129
133
  html += " defer"
@@ -1,17 +1,26 @@
1
1
  from __future__ import annotations
2
2
 
3
+ import dataclasses
3
4
  from typing import Any, Literal, TYPE_CHECKING
4
5
 
5
6
  from mknodes.templatenodes import mktemplate
6
7
  from mknodes.utils import inspecthelpers, log
7
8
 
8
9
  if TYPE_CHECKING:
10
+ from collections.abc import Iterator
9
11
  from mknodes.data import datatypes
10
12
 
11
13
 
12
14
  logger = log.get_logger(__name__)
13
15
 
14
16
 
17
+ @dataclasses.dataclass
18
+ class Section:
19
+ typ: str
20
+ code: str
21
+ start_line: int | None = None
22
+
23
+
15
24
  class MkCommentedCode(mktemplate.MkTemplate):
16
25
  """Node which displays a list of code / comment blocks for given code.
17
26
 
@@ -48,6 +57,37 @@ class MkCommentedCode(mktemplate.MkTemplate):
48
57
  self.style = style
49
58
  super().__init__(template="output/markdown/template", **kwargs)
50
59
 
60
+ def iter_code_sections(self) -> Iterator[Section]:
61
+
62
+ lines: list[str] = []
63
+ mode = ""
64
+ line_num = self.linenums or 0
65
+ for i, line in enumerate(self.code.split("\n"), start=line_num):
66
+ if not line.strip() or line.rstrip().endswith("##"):
67
+ continue
68
+ if line.strip().startswith("#"):
69
+ if mode == "code":
70
+ code = "\n".join(lines)
71
+ yield Section(mode, code, start_line=line_num if self.linenums else None)
72
+ lines = []
73
+ line_num = i
74
+ lines.append(line.strip().removeprefix("#")[1:])
75
+ mode = "comment"
76
+ elif not line.strip().startswith("#"):
77
+ if mode == "comment":
78
+ text = "\n".join(lines)
79
+ yield Section("comment", text)
80
+ lines = []
81
+ line_num = i
82
+ lines.append(line)
83
+ mode = "code"
84
+ if mode == "code":
85
+ code = "\n".join(lines)
86
+ yield Section("code", code, start_line=line_num if self.linenums else None)
87
+ elif mode == "comment":
88
+ text = "\n".join(lines)
89
+ yield Section("comment", text)
90
+
51
91
  @property
52
92
  def code(self) -> str:
53
93
  match self._code:
@@ -25,7 +25,6 @@ some_code = 1 + 2
25
25
  }}
26
26
  """
27
27
 
28
-
29
28
  [examples.from_function]
30
29
  title = "From function"
31
30
  jinja = """
@@ -34,7 +33,7 @@ jinja = """
34
33
 
35
34
  [output.markdown]
36
35
  template = """
37
- {% for section in inspecthelpers.iter_code_sections(node.code, node.linenums) %}
36
+ {% for section in node.iter_code_sections() %}
38
37
  {% if section.typ == "code" %}
39
38
  {{ section.code | MkCode(linenums=section.start_line) }}
40
39
  {% elif node.style == "text" %}
@@ -46,4 +45,3 @@ template = """
46
45
  {% endif %}
47
46
  {% endfor %}
48
47
  """
49
-
@@ -0,0 +1,33 @@
1
+ from __future__ import annotations
2
+
3
+ from urllib import parse
4
+
5
+ import anyenv
6
+
7
+ from mknodes.utils import log
8
+
9
+
10
+ logger = log.get_logger(__name__)
11
+
12
+
13
+ def download(url: str, headers: dict[str, str] | None = None) -> bytes:
14
+ """Download a file from given URL and return its content.
15
+
16
+ If the URL is a local path, it is simply read and returned instead.
17
+
18
+ Args:
19
+ url: URL or local path of the file to use
20
+ headers: Headers to use for the request
21
+
22
+ Returns:
23
+ The downloaded content as bytes
24
+ """
25
+ from upath import UPath
26
+
27
+ logger.debug("Getting file for '%s'", url)
28
+ if parse.urlsplit(url).scheme not in {"http", "https"}:
29
+ path = UPath(url)
30
+ return path.read_bytes()
31
+ content = anyenv.get_bytes_sync(url, cache=True, headers=headers)
32
+ logger.debug("Downloaded %s", url)
33
+ return content
@@ -41,12 +41,7 @@ def icon_for_url(url: str) -> str | None:
41
41
  def _patch_index_with_sets(_icon_sets: Sequence[str]) -> dict[str, Any]:
42
42
  from pymdownx import twemoji_db # type: ignore[import-untyped]
43
43
 
44
- # Copy the Twemoji index
45
- index: dict[str, Any] = {
46
- "name": "twemoji",
47
- "emoji": twemoji_db.emoji,
48
- "aliases": twemoji_db.aliases,
49
- }
44
+ index = {"name": "twemoji", "emoji": twemoji_db.emoji, "aliases": twemoji_db.aliases}
50
45
  # icon_index = _get_pyconify_icon_index(*icon_sets)
51
46
  icon_index = icons.load_icon_index()
52
47
  index["emoji"].update(icon_index)
@@ -1,6 +1,5 @@
1
1
  from __future__ import annotations
2
2
 
3
- import dataclasses
4
3
  import functools
5
4
  import inspect
6
5
  from typing import TYPE_CHECKING, Any
@@ -16,43 +15,6 @@ if TYPE_CHECKING:
16
15
  from mknodes.data import datatypes
17
16
 
18
17
 
19
- def iter_code_sections(code_string: str, start_line: int | None = None):
20
- @dataclasses.dataclass
21
- class Section:
22
- typ: str
23
- code: str
24
- start_line: int | None = None
25
-
26
- lines: list[str] = []
27
- mode = ""
28
- line_num = start_line or 0
29
- for i, line in enumerate(code_string.split("\n"), start=line_num):
30
- if not line.strip() or line.rstrip().endswith("##"):
31
- continue
32
- if line.strip().startswith("#"):
33
- if mode == "code":
34
- code = "\n".join(lines)
35
- yield Section(mode, code, start_line=line_num if start_line else None)
36
- lines = []
37
- line_num = i
38
- lines.append(line.strip().removeprefix("#")[1:])
39
- mode = "comment"
40
- elif not line.strip().startswith("#"):
41
- if mode == "comment":
42
- text = "\n".join(lines)
43
- yield Section("comment", text)
44
- lines = []
45
- line_num = i
46
- lines.append(line)
47
- mode = "code"
48
- if mode == "code":
49
- code = "\n".join(lines)
50
- yield Section("code", code, start_line=line_num if start_line else None)
51
- elif mode == "comment":
52
- text = "\n".join(lines)
53
- yield Section("comment", text)
54
-
55
-
56
18
  def get_stack_info(frame: types.FrameType | None, level: int) -> dict[str, Any] | None:
57
19
  for _ in range(level):
58
20
  assert frame
@@ -106,9 +68,7 @@ def get_source(obj: datatypes.HasCodeType | griffe.Object) -> str:
106
68
 
107
69
 
108
70
  @functools.cache
109
- def get_source_lines(
110
- obj: datatypes.HasCodeType | griffe.Object,
111
- ) -> tuple[list[str], int]:
71
+ def get_source_lines(obj: datatypes.HasCodeType | griffe.Object) -> tuple[list[str], int]:
112
72
  """Cached wrapper for inspect.getsourcelines.
113
73
 
114
74
  Args:
@@ -2,6 +2,7 @@ from __future__ import annotations
2
2
 
3
3
  import abc
4
4
  from collections.abc import Mapping
5
+ from dataclasses import dataclass
5
6
  import io
6
7
  import itertools
7
8
  import os
@@ -30,34 +31,25 @@ INV_HEADER = """\
30
31
  """
31
32
 
32
33
 
34
+ @dataclass
33
35
  class InventoryItem:
34
36
  """Inventory item."""
35
37
 
36
- def __init__(
37
- self,
38
- name: str,
39
- domain: str,
40
- role: str,
41
- uri: str,
42
- priority: int = 1,
43
- dispname: str | None = None,
44
- ) -> None:
45
- """Initialize the object.
46
-
47
- Args:
48
- name: The item name.
49
- domain: The item domain, like 'python'
50
- role: The item role, like 'class' or 'method'.
51
- uri: The item URI.
52
- priority: The item priority.
53
- dispname: The item display name.
54
- """
55
- self.name: str = name
56
- self.domain: str = domain
57
- self.role: str = role
58
- self.uri: str = uri
59
- self.priority: int = priority
60
- self.dispname: str = dispname or name
38
+ name: str
39
+ """The item name."""
40
+ domain: str
41
+ """The item domain, like 'python'"""
42
+ role: str
43
+ """The item role, like 'class' or 'method'."""
44
+ uri: str
45
+ """The item URI."""
46
+ priority: int = 1
47
+ """The item priority."""
48
+ dispname: str | None = None
49
+ """The item display name."""
50
+
51
+ def __post_init__(self):
52
+ self.dispname = self.dispname or self.name
61
53
 
62
54
  def format_sphinx(self) -> str:
63
55
  """Format this item as a Sphinx inventory line and return it."""
@@ -143,10 +135,11 @@ class BaseInventory(dict[str, InventoryItem]):
143
135
  def format_sphinx(self) -> bytes:
144
136
  """Format this inventory as a Sphinx `objects.inv` file and return it."""
145
137
  header = INV_HEADER.format(project=self.project, version=self.version).encode()
146
- lines = [
147
- item.format_sphinx().encode()
148
- for item in sorted(self.values(), key=lambda item: (item.domain, item.name))
149
- ]
138
+
139
+ def get_key(item: InventoryItem) -> tuple[str, str]:
140
+ return (item.domain, item.name)
141
+
142
+ lines = [item.format_sphinx().encode() for item in sorted(self.values(), key=get_key)]
150
143
  return header + zlib.compress(b"\n".join(lines) + b"\n", 9)
151
144
 
152
145
  @classmethod
@@ -14,10 +14,6 @@ class Logger:
14
14
  def __getattr__(self, val: Any):
15
15
  return getattr(self.logger, val)
16
16
 
17
- def log_dict(self, dct: dict[str, Any], level: int = logging.INFO) -> None:
18
- for k, v in dct.items():
19
- self.logger.log(level, "%s: %s", k, v)
20
-
21
17
 
22
18
  def get_logger(name: str | None = None):
23
19
  if importlib.util.find_spec("mkdocs"):
@@ -1,7 +1,6 @@
1
1
  from __future__ import annotations
2
2
 
3
3
  import functools
4
- import importlib
5
4
  from typing import TYPE_CHECKING, Any
6
5
 
7
6
  from packaging.markers import Marker
@@ -13,7 +12,6 @@ from mknodes.utils import log
13
12
  if TYPE_CHECKING:
14
13
  from collections.abc import Container
15
14
  from importlib import metadata
16
- import types
17
15
 
18
16
 
19
17
  logger = log.get_logger(__name__)
@@ -41,15 +39,6 @@ def get_extras(markers: list[list[Any] | tuple[Any, ...]]) -> list[str]:
41
39
  return extras
42
40
 
43
41
 
44
- def import_dotted_path(path: str) -> type | types.ModuleType:
45
- if ":" in path:
46
- mod_name, kls_name = path.split(":")
47
- else:
48
- mod_name, kls_name = path, None
49
- mod = importlib.import_module(mod_name)
50
- return getattr(mod, kls_name) if kls_name else mod
51
-
52
-
53
42
  class Dependency:
54
43
  def __init__(self, name: str) -> None:
55
44
  self.req = Requirement(name)
@@ -0,0 +1,49 @@
1
+ from __future__ import annotations
2
+
3
+ import functools
4
+ from typing import TYPE_CHECKING
5
+
6
+ from upathtools import to_upath
7
+
8
+ from mknodes.utils import log
9
+ from mknodes.utils.downloadhelpers import download
10
+
11
+
12
+ if TYPE_CHECKING:
13
+ import os
14
+
15
+ import upath
16
+ from upath.types import JoinablePathLike
17
+
18
+
19
+ logger = log.get_logger(__name__)
20
+
21
+
22
+ def find_cfg_for_folder(
23
+ filename: JoinablePathLike,
24
+ folder: JoinablePathLike = ".",
25
+ ) -> upath.UPath | None:
26
+ """Search for a file with given name in folder and its parent folders.
27
+
28
+ Args:
29
+ filename: File to search
30
+ folder: Folder to start searching from
31
+ """
32
+ if folder and str(folder) != ".":
33
+ path = to_upath(folder).resolve() / str(filename)
34
+ else:
35
+ path = to_upath(filename).resolve()
36
+ while len(path.parts) > 1:
37
+ path = path.parent
38
+ if (file := path / str(filename)).exists():
39
+ return file
40
+ return None
41
+
42
+
43
+ @functools.cache
44
+ def load_file_cached(path: str | os.PathLike[str]) -> str:
45
+ return download(str(path)).decode()
46
+
47
+
48
+ if __name__ == "__main__":
49
+ file = find_cfg_for_folder("github://phil65:mknodes@main/docs/icons.jinja")
@@ -5,8 +5,9 @@ from collections.abc import MutableMapping
5
5
  from typing import TYPE_CHECKING, Any, Literal, Self, TypeVar
6
6
 
7
7
  from jinjarope import serializefilters
8
+ from upathtools.helpers import write_file
8
9
 
9
- from mknodes.utils import pathhelpers, reprhelpers
10
+ from mknodes.utils import reprhelpers
10
11
 
11
12
 
12
13
  if TYPE_CHECKING:
@@ -79,7 +80,7 @@ class SuperDict(MutableMapping[str, V], metaclass=ABCMeta):
79
80
 
80
81
  def write(self, path: str | os.PathLike[str], mode: MarkupTypeStr) -> None:
81
82
  text = self.serialize(mode)
82
- pathhelpers.write_file(text, path)
83
+ write_file(text, path)
83
84
 
84
85
 
85
86
  if __name__ == "__main__":
@@ -3,7 +3,7 @@ from __future__ import annotations
3
3
  from typing import Any
4
4
  from xml.etree import ElementTree as ET
5
5
 
6
- from mknodes.utils import icons, log
6
+ from mknodes.utils import log
7
7
 
8
8
 
9
9
  logger = log.get_logger(__name__)
@@ -159,20 +159,5 @@ class A(HTMLElement):
159
159
  self.text = text
160
160
 
161
161
 
162
- def get_source_button(icon: str = "material/code-json") -> A:
163
- href = (
164
- "{{ config.site_url | rstrip('/') + '/src/' + page.file.src_uri | replace('.md',"
165
- " '.original') }}"
166
- )
167
- elem = A(
168
- "md-content__button md-icon",
169
- title="Source",
170
- href=href,
171
- )
172
- svg = icons.get_icon_xml(icon)
173
- elem.append(svg)
174
- return elem
175
-
176
-
177
162
  if __name__ == "__main__":
178
163
  a = Div("test")
@@ -1,182 +0,0 @@
1
- from __future__ import annotations
2
-
3
- import dataclasses
4
- import datetime
5
- from typing import Any
6
-
7
- from mknodes.basenodes import mktext
8
- from mknodes.info import configfile
9
- from mknodes.navs import mknav
10
- from mknodes.pages import metadata, mkpage
11
- from mknodes.utils import resources
12
-
13
-
14
- @dataclasses.dataclass(frozen=True)
15
- class Author:
16
- """A blog post author."""
17
-
18
- name: str
19
- description: str | None = None
20
- avatar: str | None = None
21
-
22
-
23
- class BlogMetadata(metadata.Metadata):
24
- """Extended Metadata class for blog posts."""
25
-
26
- @property
27
- def date(self) -> str | None:
28
- return self.get("date")
29
-
30
- @date.setter
31
- def date(self, val: str | None) -> None:
32
- self["date"] = val
33
-
34
- @property
35
- def draft(self) -> bool | None:
36
- return self.get("draft")
37
-
38
- @draft.setter
39
- def draft(self, val: bool | None) -> None:
40
- self["draft"] = val
41
-
42
- @property
43
- def categories(self) -> list[str] | None:
44
- return self.get("categories")
45
-
46
- @categories.setter
47
- def categories(self, val: list[str] | None) -> None:
48
- self["categories"] = val
49
-
50
- @property
51
- def authors(self) -> list[str] | None:
52
- return self.get("authors")
53
-
54
- @authors.setter
55
- def authors(self, val: list[str] | None) -> None:
56
- self["authors"] = val
57
-
58
-
59
- class MkBlog(mknav.MkNav):
60
- """Class representing the blog provided by the MkDocs-Material blog plugin."""
61
-
62
- def __init__(self, title: str | None = "Blog", **kwargs: Any) -> None:
63
- super().__init__(section=title, **kwargs)
64
- self.authors: dict[str, Author] = {}
65
- # self.posts = mknav.MkNav("posts", parent=self)
66
- # self.index_page = mkpage.MkPage()
67
-
68
- def add_author(
69
- self,
70
- username: str,
71
- name: str,
72
- description: str | None = None,
73
- avatar: str | None = None,
74
- ) -> None:
75
- """Add an author to the blog.
76
-
77
- Authors get linked to the blog post authors to show extended information.
78
-
79
- Args:
80
- username: Username / slug of the author
81
- name: Full name of the author
82
- description: Short description of the author
83
- avatar: Url to an image used as avatar
84
- """
85
- author = Author(name=name, description=description, avatar=avatar)
86
- self.authors[username] = author
87
-
88
- async def get_node_resources(self) -> resources.Resources:
89
- """Return required resources for this node."""
90
- authors_file = configfile.YamlFile()
91
- dct = {k: dataclasses.asdict(v) for k, v in self.authors.items()}
92
- authors_file._data["authors"] = dct
93
- content = authors_file.serialize("yaml")
94
- return resources.Resources(
95
- assets=[
96
- resources.Asset("blog/.authors.yml", content, target="docs_dir"),
97
- ],
98
- )
99
-
100
- def add_post(
101
- self,
102
- text: str,
103
- date: datetime.datetime | str,
104
- more_text: str | None = None,
105
- *,
106
- categories: list[str] | str | None = None,
107
- authors: list[str] | str | None = None,
108
- draft: bool = False,
109
- **kwargs: Any,
110
- ) -> None:
111
- """Add a post to the blog.
112
-
113
- Args:
114
- text: Blog post text
115
- date: Time/Date of the post
116
- more_text: Text hidden behint the more button.
117
- categories: A list of categories this post is linked to
118
- authors: A list of authors of the post
119
- draft: Whether post is a draft
120
- kwargs: Keyword arguments passed to parent
121
- """
122
- page = MkBlogPost(
123
- date=date,
124
- draft=draft,
125
- categories=categories,
126
- authors=authors,
127
- **kwargs,
128
- )
129
- page += mktext.MkText(text)
130
- if more_text:
131
- page += "\n\n<!-- more -->\n\n"
132
- page += more_text
133
- self += page
134
-
135
-
136
- class MkBlogPost(mkpage.MkPage):
137
- """Class representing a MkDocs-Material blog post."""
138
-
139
- DATE_FORMAT = "%Y-%m-%d"
140
-
141
- def __init__(
142
- self,
143
- date: str | datetime.datetime,
144
- *,
145
- draft: bool = True,
146
- categories: list[str] | str | None = None,
147
- authors: list[str] | str | None = None,
148
- **kwargs: Any,
149
- ) -> None:
150
- """Constructor.
151
-
152
- Args:
153
- date: Time/Date of the post
154
- draft: Whether post is a draft
155
- categories: A list of categories this post is linked to
156
- authors: A list of authors of the post
157
- kwargs: Keyword arguments passed to parent
158
- """
159
- super().__init__(**kwargs)
160
- if isinstance(authors, str):
161
- authors = [authors]
162
- if isinstance(categories, str):
163
- categories = [categories]
164
- self.metadata = BlogMetadata(
165
- **self.metadata,
166
- date=(
167
- date
168
- if isinstance(date, str)
169
- else datetime.datetime.strftime(date, self.DATE_FORMAT)
170
- ),
171
- draft=draft,
172
- categories=categories or [],
173
- authors=authors or [],
174
- )
175
-
176
-
177
- if __name__ == "__main__":
178
- blog = MkBlog()
179
- blog.add_post("Hello", "2020-01-01", "more")
180
- page = blog.nav.get_pages()[0]
181
- print(page.metadata)
182
- print(blog)