mkdocs-mknodes 0.2.16__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.2.16 → mkdocs_mknodes-0.3.1}/.pre-commit-config.yaml +2 -5
  2. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/PKG-INFO +2 -1
  3. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs.yml +1 -0
  4. mkdocs_mknodes-0.3.1/mkdocs_mknodes/__init__.py +1 -0
  5. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/backends/markdownbackend.py +5 -5
  6. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/backends/mkdocsbackend.py +12 -11
  7. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/buildcollector.py +41 -13
  8. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/commands/serve.py +0 -18
  9. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/mkdocsconfig.py +4 -8
  10. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/plugin/__init__.py +11 -3
  11. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/plugin/pluginconfig.py +45 -4
  12. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/pyproject.toml +5 -3
  13. mkdocs_mknodes-0.2.16/mkdocs_mknodes/__init__.py +0 -1
  14. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/.editorconfig +0 -0
  15. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/.github/README.md +0 -0
  16. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/.github/workflows/build.yml +0 -0
  17. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/.github/workflows/documentation.yml +0 -0
  18. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/.gitignore +0 -0
  19. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/LICENSE +0 -0
  20. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/Makefile +0 -0
  21. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/README.md +0 -0
  22. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/configs/mkdocs_mkdocs.yml +0 -0
  23. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/configs/mkdocs_mkdocstrings.yml +0 -0
  24. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/configs/mkdocs_multipage.yml +0 -0
  25. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/configs/mkdocs_shared.yml +0 -0
  26. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/docs/assets/cli.gif +0 -0
  27. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/backends/__init__.py +0 -0
  28. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/backends/buildbackend.py +0 -0
  29. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/buildcontext.py +0 -0
  30. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/cli/__init__.py +0 -0
  31. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/cli/richstate.py +0 -0
  32. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/commands/__init__.py +0 -0
  33. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/commands/build_page.py +0 -0
  34. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/__init__.py +0 -0
  35. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/cli_section.py +0 -0
  36. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/get_started_section.py +0 -0
  37. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/github_index.py +0 -0
  38. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/multi_project.py +0 -0
  39. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/root.py +0 -0
  40. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/manual/use_cases_section.py +0 -0
  41. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/paths.py +0 -0
  42. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/plugin/mkdocsbuilder.py +0 -0
  43. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
  44. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
  45. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/py.typed +0 -0
  46. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/build_process.jinja +0 -0
  47. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/cli_index.jinja +0 -0
  48. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/github_index.jinja +0 -0
  49. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/index.jinja +0 -0
  50. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
  51. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/plugin_configuration.jinja +0 -0
  52. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
  53. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/use_case_by_config.jinja +0 -0
  54. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/use_case_default_website.jinja +0 -0
  55. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/use_case_subwebsites.jinja +0 -0
  56. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/use_cases_index.jinja +0 -0
  57. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes/resources/why_should_i_use_mknodes.jinja +0 -0
  58. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/mkdocs_mknodes.sublime-project +0 -0
  59. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/overrides/_dummy.txt +0 -0
  60. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/overrides/partials/actions.html +0 -0
  61. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/tests/__init__.py +0 -0
  62. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/tests/conftest.py +0 -0
  63. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/tests/data/objects.inv +0 -0
  64. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/tests/test_build.py +0 -0
  65. {mkdocs_mknodes-0.2.16 → mkdocs_mknodes-0.3.1}/tests/test_cli.py +0 -0
@@ -27,10 +27,6 @@ repos:
27
27
  - id: forbid-new-submodules
28
28
  # - id: check-added-large-files
29
29
  # https://pre-commit.com/hooks.html
30
- - repo: https://github.com/psf/black-pre-commit-mirror
31
- rev: 23.10.1
32
- hooks:
33
- - id: black
34
30
 
35
31
  - repo: https://github.com/pre-commit/mirrors-mypy
36
32
  rev: v1.6.1
@@ -40,9 +36,10 @@ repos:
40
36
  additional_dependencies: [mkdocs]
41
37
 
42
38
  - repo: https://github.com/charliermarsh/ruff-pre-commit
43
- rev: v0.1.2
39
+ rev: v0.1.3
44
40
  hooks:
45
41
  - id: ruff
42
+ - id: ruff-format
46
43
 
47
44
  - repo: https://github.com/commitizen-tools/commitizen
48
45
  rev: 3.12.0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: mkdocs-mknodes
3
- Version: 0.2.16
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
@@ -29,6 +29,7 @@ Requires-Dist: mkdocs>=1.5
29
29
  Requires-Dist: mknodes
30
30
  Requires-Dist: rich
31
31
  Requires-Dist: typer
32
+ Requires-Dist: universal-pathlib
32
33
  Description-Content-Type: text/markdown
33
34
 
34
35
  ``` py title='__main__.create_github_index_md' linenums="86" hl_lines="3"
@@ -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"
@@ -1,9 +1,9 @@
1
1
  from __future__ import annotations
2
2
 
3
3
  import os
4
- import pathlib
5
4
 
6
5
  from mknodes.utils import log, pathhelpers
6
+ import upath
7
7
 
8
8
  from mkdocs_mknodes.backends import buildbackend
9
9
 
@@ -24,15 +24,15 @@ class MarkdownBackend(buildbackend.BuildBackend):
24
24
  extension: Extention of files to generate
25
25
  """
26
26
  self.extension = extension
27
- self.directory = pathlib.Path(directory or ".")
27
+ self.directory = upath.UPath(directory or ".")
28
28
  self._files: dict[str, str | bytes] = {}
29
29
 
30
30
  def collect_files(self, files: dict[str, str | bytes]):
31
31
  for k, v in files.items():
32
32
  logger.debug("%s: Writing file to %r", type(self).__name__, str(k))
33
- target_path = (self.directory / k).with_suffix(self.extension).as_posix()
34
- self._files[str(target_path)] = v
35
- pathhelpers.write_file(v, str(target_path))
33
+ target_path = (self.directory / k).with_suffix(self.extension)
34
+ self._files[target_path.as_posix()] = v
35
+ pathhelpers.write_file(v, target_path)
36
36
 
37
37
  # def write(self):
38
38
  # for k, v in self._files.items():
@@ -11,6 +11,7 @@ from mkdocs.config.defaults import MkDocsConfig
11
11
  from mkdocs.plugins import get_plugin_logger
12
12
  from mkdocs.structure import files as files_
13
13
  from mknodes.utils import mergehelpers, pathhelpers, resources
14
+ import upath
14
15
 
15
16
  from mkdocs_mknodes import mkdocsconfig
16
17
  from mkdocs_mknodes.backends import buildbackend
@@ -41,7 +42,7 @@ class MkDocsBackend(buildbackend.BuildBackend):
41
42
  self._config = config
42
43
  case _:
43
44
  self._config = mkdocsconfig.Config(config)._config
44
- self.directory = pathlib.Path(directory or ".")
45
+ self.directory = upath.UPath(directory or ".")
45
46
  files_map = {pathlib.PurePath(f.src_path).as_posix(): f for f in files or []}
46
47
  self._mk_files: collections.ChainMap[str, files_.File] = collections.ChainMap(
47
48
  {},
@@ -70,18 +71,18 @@ class MkDocsBackend(buildbackend.BuildBackend):
70
71
  if pathlib.Path(k).name == "SUMMARY.md":
71
72
  continue
72
73
  logger.debug("%s: Writing file to %r", type(self).__name__, str(k))
73
- path = pathlib.Path(k).as_posix()
74
- # self._files[path] = v
75
- self._write_file(path, v)
74
+ self._write_file(k, v)
76
75
 
77
76
  def collect_assets(self, assets):
78
77
  for asset in assets:
79
78
  if asset.target_dir == "docs_dir":
80
- abs_path = pathlib.Path(self._config.docs_dir) / asset.filename
79
+ abs_path = upath.UPath(self._config.docs_dir) / asset.filename
81
80
  logger.info("Writing asset %s...", abs_path)
82
81
  pathhelpers.write_file(asset.content, abs_path)
83
82
  else:
84
- 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)
85
86
 
86
87
  def collect_css(self, css_files):
87
88
  for css in css_files:
@@ -108,7 +109,7 @@ class MkDocsBackend(buildbackend.BuildBackend):
108
109
  val.defer = file.defer
109
110
  val.type = file.typ
110
111
  self._config.extra_javascript.append(path)
111
- abs_path = pathlib.Path(self._config.site_dir) / path
112
+ abs_path = upath.UPath(self._config.site_dir) / path
112
113
  logger.info("Registering js file %s...", abs_path)
113
114
  pathhelpers.write_file(file.content, abs_path)
114
115
 
@@ -127,7 +128,7 @@ class MkDocsBackend(buildbackend.BuildBackend):
127
128
  if not self._config.theme.custom_dir:
128
129
  logger.warning("Cannot write template. No custom_dir set in config.")
129
130
  return
130
- path = pathlib.Path(self._config.theme.custom_dir)
131
+ path = upath.UPath(self._config.theme.custom_dir)
131
132
  for template in templates:
132
133
  md = self._get_parser()
133
134
  if html := template.build_html(md):
@@ -138,7 +139,7 @@ class MkDocsBackend(buildbackend.BuildBackend):
138
139
  def _write_file(self, path: str | os.PathLike, content: str | bytes):
139
140
  path = pathlib.PurePath(path).as_posix()
140
141
  file_for_path = self.builder.get_file(path, src_dir=self.directory)
141
- new_path = pathlib.Path(file_for_path.abs_src_path)
142
+ new_path = upath.UPath(file_for_path.abs_src_path)
142
143
  target_path = None
143
144
  if path not in self._mk_files:
144
145
  new_path.parent.mkdir(exist_ok=True, parents=True)
@@ -146,7 +147,7 @@ class MkDocsBackend(buildbackend.BuildBackend):
146
147
  target_path = new_path
147
148
 
148
149
  f = self._mk_files[path]
149
- source_path = pathlib.Path(f.abs_src_path)
150
+ source_path = upath.UPath(f.abs_src_path)
150
151
  if source_path != new_path:
151
152
  self._mk_files[path] = file_for_path
152
153
  pathhelpers.copy(source_path, new_path)
@@ -164,7 +165,7 @@ class MkDocsBackend(buildbackend.BuildBackend):
164
165
  """
165
166
  path = (pathlib.Path("assets") / filename).as_posix()
166
167
  self._config.extra_css.append(path)
167
- abs_path = pathlib.Path(self._config.site_dir) / path
168
+ abs_path = upath.UPath(self._config.site_dir) / path
168
169
  logger.info("Registering css file %s...", abs_path)
169
170
  pathhelpers.write_file(css, abs_path)
170
171
 
@@ -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,18 +136,22 @@ class BuildCollector:
107
136
  self,
108
137
  backends: list[buildbackend.BuildBackend],
109
138
  show_page_info: bool = False,
110
- render_all_pages: bool = True,
139
+ global_resources: bool = True,
140
+ render_by_default: bool = True,
111
141
  ):
112
142
  """Constructor.
113
143
 
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
117
- render_all_pages: Whether to resolve all MkPages with their environment
147
+ global_resources: If False, make page resources non-global by moving them
148
+ to the page template blocks
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
121
- self.render_all_pages = render_all_pages
153
+ self.global_resources = global_resources
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] = {}
124
157
  self.node_counter: collections.Counter[str] = collections.Counter()
@@ -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_all_pages = self.render_all_pages
204
- if (render := page.metadata.get("render_jinja")) is not None:
205
- render_all_pages = render
206
- if render_all_pages:
231
+ do_render = self.render_by_default
232
+ if (render := page.metadata.get("render_macros")) is not None:
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
@@ -10,12 +10,8 @@ import tempfile
10
10
  from typing import TYPE_CHECKING, Any, Literal
11
11
  from urllib.parse import urlsplit
12
12
 
13
- import jinja2.exceptions
14
-
15
-
16
13
  # from mkdocs.commands import serve as serve_
17
14
  from mkdocs.config import load_config
18
- from mkdocs.exceptions import Abort
19
15
  from mkdocs.livereload import LiveReloadServer
20
16
  from mknodes.info import mkdocsconfigfile
21
17
  from mknodes.utils import log, yamlhelpers
@@ -83,13 +79,6 @@ def serve_node(node, repo_path: str = "."):
83
79
  def catch_exceptions(config, site_dir):
84
80
  try:
85
81
  yield
86
- except jinja2.exceptions.TemplateError:
87
- # This is a subclass of OSError, but shouldn't be suppressed.
88
- raise
89
- except OSError as e: # pragma: no cover
90
- # Avoid ugly, unhelpful traceback
91
- msg = f"{type(e).__name__}: {e}"
92
- raise Abort(msg) from e
93
82
  finally:
94
83
  config.plugins.on_shutdown()
95
84
  if pathlib.Path(site_dir).is_dir():
@@ -191,13 +180,6 @@ def _serve(
191
180
  logger.info("Shutting down...")
192
181
  finally:
193
182
  server.shutdown()
194
- except jinja2.exceptions.TemplateError:
195
- # This is a subclass of OSError, but shouldn't be suppressed.
196
- raise
197
- except OSError as e: # pragma: no cover
198
- # Avoid ugly, unhelpful traceback
199
- msg = f"{type(e).__name__}: {e}"
200
- raise Abort(msg) from None
201
183
  finally:
202
184
  config.plugins.on_shutdown()
203
185
  if site_dir.is_dir():
@@ -216,14 +216,10 @@ class Config:
216
216
  rel_path = edit_path
217
217
  return parse.urljoin(base_url, rel_path)
218
218
 
219
- def get_loaders(self) -> Sequence[jinja2.BaseLoader]:
220
- jinja_loaders: list[jinja2.BaseLoader] = [loaders.FileSystemLoader(self.docs_dir)]
221
- for loader_dct in self.mknodes_config.get("jinja_loaders", []):
222
- dct = loader_dct.copy()
223
- kls = loaders.LOADERS[dct.pop("type")]
224
- loader = kls(**dct)
225
- jinja_loaders.append(loader)
226
- return jinja_loaders
219
+ def get_jinja_config(self) -> Sequence[jinja2.BaseLoader]:
220
+ cfg = self.plugin.config.get_jinja_config()
221
+ cfg["loader"] |= loaders.FileSystemLoader(self.docs_dir)
222
+ return cfg
227
223
 
228
224
  def get_install_candidates(self) -> list[str]:
229
225
  """Return a list of installation candidates for this config."""
@@ -61,12 +61,19 @@ class Build:
61
61
  clone_depth=clone_depth,
62
62
  )
63
63
 
64
- def collect_build_data(self, backends, show_page_info, render_all_pages):
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,
69
- render_all_pages=render_all_pages,
75
+ global_resources=global_resources,
76
+ render_by_default=render_by_default,
70
77
  )
71
78
  self.build_info = collector.collect(self.project.root, self.project.theme)
72
79
 
@@ -149,7 +156,8 @@ 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,
152
- render_all_pages=self.config.render_all_pages,
159
+ global_resources=self.config.global_resources,
160
+ render_by_default=self.config.render_by_default,
153
161
  )
154
162
  self.build_info = collector.collect(self.project.root, self.project.theme)
155
163
  if nav_dict := self.project.root.nav.to_nav_dict():
@@ -2,10 +2,13 @@
2
2
 
3
3
  from __future__ import annotations
4
4
 
5
- from collections.abc import Callable
5
+ from collections.abc import Callable, Sequence
6
6
  import functools
7
7
 
8
+ import jinja2
9
+
8
10
  from mkdocs.config import base, config_options as c
11
+ from mknodes.jinja import loaders
9
12
  from mknodes.utils import classhelpers
10
13
 
11
14
 
@@ -59,13 +62,22 @@ class PluginConfig(base.Config):
59
62
  - setting the theme features "navigation.indexes" and "navigation.expand" via
60
63
  page metadata.
61
64
  """
62
- render_all_pages = c.Type(bool, default=True)
65
+ render_by_default = c.Type(bool, default=True)
63
66
  """Render all pages in the jinja environment.
64
67
 
65
68
  This allows to render jinja in the **MkNodes** environment outside of the `MkJinja`
66
69
  nodes.
67
70
 
68
- This setting can be overridden by setting the page metadata field "render_jinja".
71
+ This setting can be overridden by setting the page metadata field "render_macros".
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)
69
81
  """
70
82
  jinja_loaders = c.Optional(c.ListOfItems(c.Type(dict)))
71
83
  """List containing additional jinja loaders to use.
@@ -78,7 +90,7 @@ class PluginConfig(base.Config):
78
90
  - mknodes:
79
91
  jinja_loaders:
80
92
  - type: fsspec
81
- protocol: github
93
+ path: github://
82
94
  repo: mknodes
83
95
  org: phil65
84
96
  ```
@@ -94,8 +106,37 @@ class PluginConfig(base.Config):
94
106
  - jinja2_ansible_filters.AnsibleCoreFiltersExtension
95
107
  ```
96
108
  """
109
+ jinja_block_start_string = c.Optional(c.Type(str))
110
+ """Jinja block start string."""
111
+ jinja_block_end_string = c.Optional(c.Type(str))
112
+ """Jinja block end string."""
113
+ jinja_variable_start_string = c.Optional(c.Type(str))
114
+ """Jinja variable start string."""
115
+ jinja_variable_end_string = c.Optional(c.Type(str))
116
+ """Jinja variable end string."""
117
+ jinja_on_undefined = c.Type(str, default="strict")
118
+ """Jinja undefined macro behavior."""
97
119
 
98
120
  def get_builder(self) -> Callable:
99
121
  build_fn = classhelpers.to_callable(self.build_fn)
100
122
  build_kwargs = self.kwargs or {}
101
123
  return functools.partial(build_fn, **build_kwargs)
124
+
125
+ def get_jinja_config(self) -> dict:
126
+ return dict(
127
+ block_start_string=self.jinja_block_start_string,
128
+ block_end_string=self.jinja_block_end_string,
129
+ variable_start_string=self.jinja_variable_start_string,
130
+ variable_end_string=self.jinja_variable_end_string,
131
+ undefined=self.jinja_on_undefined,
132
+ loader=loaders.ChoiceLoader(self.get_loaders()),
133
+ )
134
+
135
+ def get_loaders(self) -> Sequence[jinja2.BaseLoader]:
136
+ jinja_loaders: list[jinja2.BaseLoader] = []
137
+ for loader_dct in self.jinja_loaders or []:
138
+ dct = loader_dct.copy()
139
+ kls = loaders.LOADERS[dct.pop("type")]
140
+ loader = kls(**dct)
141
+ jinja_loaders.append(loader)
142
+ return jinja_loaders
@@ -15,7 +15,6 @@ virtual = ".hatch"
15
15
  python = "3.11"
16
16
  dependencies = [
17
17
  # Linting
18
- "black",
19
18
  "mypy",
20
19
  "ruff",
21
20
 
@@ -27,6 +26,8 @@ dependencies = [
27
26
  "pymdown-extensions",
28
27
  "mkdocs-material >= 9.4",
29
28
  "mkdocstrings[python]",
29
+ # used for formatting signature
30
+ "black",
30
31
  "pygments",
31
32
  "mkdocs-mknodes",
32
33
 
@@ -45,12 +46,12 @@ test-cov-xml = "pytest --cov-report=xml"
45
46
  test-cov-html = "pytest --cov-report=html"
46
47
  lint = [
47
48
  "hatch run ruff --fix .",
48
- "hatch run black .",
49
+ "hatch run ruff format .",
49
50
  "hatch run mypy mkdocs_mknodes/",
50
51
  ]
51
52
  lint-check = [
52
53
  "hatch run ruff .",
53
- "hatch run black --check .",
54
+ "hatch run ruff format --check .",
54
55
  "hatch run mypy mkdocs_mknodes/",
55
56
  ]
56
57
 
@@ -109,6 +110,7 @@ dependencies = [
109
110
 
110
111
  # Tools
111
112
  "jinja2",
113
+ "universal_pathlib",
112
114
  ]
113
115
  license = "MIT"
114
116
 
@@ -1 +0,0 @@
1
- __version__ = "0.2.16"
File without changes
File without changes