mkdocs-mknodes 0.3.0__tar.gz → 0.3.1__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 (65) hide show
  1. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/PKG-INFO +1 -1
  2. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs.yml +1 -0
  3. mkdocs_mknodes-0.3.1/mkdocs_mknodes/__init__.py +1 -0
  4. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/backends/mkdocsbackend.py +3 -1
  5. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/buildcollector.py +37 -9
  6. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/plugin/__init__.py +9 -1
  7. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/plugin/pluginconfig.py +9 -0
  8. mkdocs_mknodes-0.3.0/mkdocs_mknodes/__init__.py +0 -1
  9. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/.editorconfig +0 -0
  10. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/.github/README.md +0 -0
  11. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/.github/workflows/build.yml +0 -0
  12. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/.github/workflows/documentation.yml +0 -0
  13. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/.gitignore +0 -0
  14. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/.pre-commit-config.yaml +0 -0
  15. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/LICENSE +0 -0
  16. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/Makefile +0 -0
  17. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/README.md +0 -0
  18. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/configs/mkdocs_mkdocs.yml +0 -0
  19. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/configs/mkdocs_mkdocstrings.yml +0 -0
  20. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/configs/mkdocs_multipage.yml +0 -0
  21. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/configs/mkdocs_shared.yml +0 -0
  22. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/docs/assets/cli.gif +0 -0
  23. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/backends/__init__.py +0 -0
  24. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/backends/buildbackend.py +0 -0
  25. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/backends/markdownbackend.py +0 -0
  26. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/buildcontext.py +0 -0
  27. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/cli/__init__.py +0 -0
  28. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/cli/richstate.py +0 -0
  29. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/commands/__init__.py +0 -0
  30. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/commands/build_page.py +0 -0
  31. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/commands/serve.py +0 -0
  32. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/__init__.py +0 -0
  33. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/cli_section.py +0 -0
  34. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/get_started_section.py +0 -0
  35. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/github_index.py +0 -0
  36. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/multi_project.py +0 -0
  37. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/root.py +0 -0
  38. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/use_cases_section.py +0 -0
  39. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/mkdocsconfig.py +0 -0
  40. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/paths.py +0 -0
  41. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/plugin/mkdocsbuilder.py +0 -0
  42. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
  43. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
  44. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/py.typed +0 -0
  45. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/build_process.jinja +0 -0
  46. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/cli_index.jinja +0 -0
  47. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/github_index.jinja +0 -0
  48. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/index.jinja +0 -0
  49. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
  50. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/plugin_configuration.jinja +0 -0
  51. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
  52. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/use_case_by_config.jinja +0 -0
  53. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/use_case_default_website.jinja +0 -0
  54. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/use_case_subwebsites.jinja +0 -0
  55. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/use_cases_index.jinja +0 -0
  56. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/why_should_i_use_mknodes.jinja +0 -0
  57. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes.sublime-project +0 -0
  58. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/overrides/_dummy.txt +0 -0
  59. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/overrides/partials/actions.html +0 -0
  60. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/pyproject.toml +0 -0
  61. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/tests/__init__.py +0 -0
  62. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/tests/conftest.py +0 -0
  63. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/tests/data/objects.inv +0 -0
  64. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/tests/test_build.py +0 -0
  65. {mkdocs_mknodes-0.3.0 → mkdocs_mknodes-0.3.1}/tests/test_cli.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: mkdocs-mknodes
3
- Version: 0.3.0
3
+ Version: 0.3.1
4
4
  Summary: Don't write docs. Code them.
5
5
  Project-URL: Documentation, https://phil65.github.io/mkdocs_mknodes/
6
6
  Project-URL: Source, https://github.com/phil65/mkdocs_mknodes
@@ -53,6 +53,7 @@ plugins:
53
53
  - mknodes:
54
54
  build_fn: mkdocs_mknodes.manual.root:build
55
55
  show_page_info: true
56
+ global_resources: false
56
57
  - mkdocstrings:
57
58
  default_handler: python
58
59
  handlers:
@@ -0,0 +1 @@
1
+ __version__ = "0.3.1"
@@ -80,7 +80,9 @@ class MkDocsBackend(buildbackend.BuildBackend):
80
80
  logger.info("Writing asset %s...", abs_path)
81
81
  pathhelpers.write_file(asset.content, abs_path)
82
82
  else:
83
- raise ValueError(asset.target_dir)
83
+ path = (pathlib.Path("assets") / asset.filename).as_posix()
84
+ abs_path = upath.UPath(self._config.site_dir) / path
85
+ pathhelpers.write_file(asset.content, abs_path)
84
86
 
85
87
  def collect_css(self, css_files):
86
88
  for css in css_files:
@@ -87,6 +87,35 @@ def update_nav_template(nav: mk.MkNav):
87
87
  nav.page_template.extends = extends
88
88
 
89
89
 
90
+ def process_resources(page: mk.MkPage) -> resources.Resources:
91
+ """Add resources from page to its template and return the "filtered" resources."""
92
+ req = page.get_resources()
93
+ reqs = []
94
+ for i in req.js:
95
+ if isinstance(i, resources.JSText):
96
+ file = resources.JSFile(
97
+ link="../../assets/" + i.resolved_filename,
98
+ async_=i.async_,
99
+ defer=i.defer,
100
+ crossorigin=i.crossorigin,
101
+ typ=i.typ,
102
+ is_library=i.is_library,
103
+ )
104
+ else:
105
+ file = i
106
+ reqs.append(file)
107
+ non_libs = [i for i in reqs if not i.is_library]
108
+ libs = [i for i in reqs if i.is_library]
109
+ assets = [i.get_asset() for i in req.js if isinstance(i, resources.JSText)]
110
+ req.assets += assets
111
+ req.js = []
112
+ for lib in libs:
113
+ page.template.libs.add_script_file(lib)
114
+ for lib in non_libs:
115
+ page.template.scripts.add_script_file(lib)
116
+ return req
117
+
118
+
90
119
  def _get_extends_from_parent(node: mk.MkPage | mk.MkNav) -> str | None:
91
120
  """Check parent navs for a page template and return its path if one was found.
92
121
 
@@ -107,6 +136,7 @@ class BuildCollector:
107
136
  self,
108
137
  backends: list[buildbackend.BuildBackend],
109
138
  show_page_info: bool = False,
139
+ global_resources: bool = True,
110
140
  render_by_default: bool = True,
111
141
  ):
112
142
  """Constructor.
@@ -114,10 +144,13 @@ class BuildCollector:
114
144
  Arguments:
115
145
  backends: A list of backends which should be used for building
116
146
  show_page_info: Add a admonition box containing page build info to each page
147
+ global_resources: If False, make page resources non-global by moving them
148
+ to the page template blocks
117
149
  render_by_default: Whether to resolve all MkPages with their environment
118
150
  """
119
151
  self.backends = backends
120
152
  self.show_page_info = show_page_info
153
+ self.global_resources = global_resources
121
154
  self.render_by_default = render_by_default
122
155
  self.node_files: dict[str, str | bytes] = {}
123
156
  self.extra_files: dict[str, str | bytes] = {}
@@ -180,12 +213,7 @@ class BuildCollector:
180
213
  return
181
214
  path = page.resolved_file_path
182
215
  self.mapping[path] = page
183
- req = page.get_resources()
184
-
185
- # libs = [i for i in req.js_files if i.is_library]
186
- # req.remove(*libs)
187
- # for lib in libs:
188
- # page.template.libs.add_script_file(lib)
216
+ req = page.get_resources() if self.global_resources else process_resources(page)
189
217
  self.resources.merge(req)
190
218
  update_page_template(page)
191
219
  show_info = page.resolved_metadata.get("show_page_info")
@@ -200,10 +228,10 @@ class BuildCollector:
200
228
  page: Page to render.
201
229
  """
202
230
  md = page.to_markdown()
203
- render_by_default = self.render_by_default
231
+ do_render = self.render_by_default
204
232
  if (render := page.metadata.get("render_macros")) is not None:
205
- render_by_default = render
206
- if render_by_default:
233
+ do_render = render
234
+ if do_render:
207
235
  md = page.env.render_string(md)
208
236
 
209
237
  self.node_files[page.resolved_file_path] = md
@@ -61,11 +61,18 @@ class Build:
61
61
  clone_depth=clone_depth,
62
62
  )
63
63
 
64
- def collect_build_data(self, backends, show_page_info, render_by_default):
64
+ def collect_build_data(
65
+ self,
66
+ backends: list,
67
+ show_page_info: bool,
68
+ global_resources: bool,
69
+ render_by_default: bool,
70
+ ):
65
71
  logger.info("Setting up build backends...")
66
72
  collector = buildcollector.BuildCollector(
67
73
  backends=backends,
68
74
  show_page_info=show_page_info,
75
+ global_resources=global_resources,
69
76
  render_by_default=render_by_default,
70
77
  )
71
78
  self.build_info = collector.collect(self.project.root, self.project.theme)
@@ -149,6 +156,7 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
149
156
  collector = buildcollector.BuildCollector(
150
157
  backends=[mkdocs_backend, markdown_backend],
151
158
  show_page_info=self.config.show_page_info,
159
+ global_resources=self.config.global_resources,
152
160
  render_by_default=self.config.render_by_default,
153
161
  )
154
162
  self.build_info = collector.collect(self.project.root, self.project.theme)
@@ -70,6 +70,15 @@ class PluginConfig(base.Config):
70
70
 
71
71
  This setting can be overridden by setting the page metadata field "render_macros".
72
72
  """
73
+ global_resources = c.Type(bool, default=True)
74
+ """Make resources globally available.
75
+
76
+ If True, then the resources inferred from the nodes will be put into all HTML pages.
77
+ (This reflects the "default" MkDocs mechanism of putting extra CSS / JS into the
78
+ config file)
79
+ If False, then MkNodes will put the CSS / JS only into the pages which need it.
80
+ (the resources will be moved into the appropriate page template blocks)
81
+ """
73
82
  jinja_loaders = c.Optional(c.ListOfItems(c.Type(dict)))
74
83
  """List containing additional jinja loaders to use.
75
84
 
@@ -1 +0,0 @@
1
- __version__ = "0.3.0"
File without changes
File without changes
File without changes