mkdocs-mknodes 0.4.4__tar.gz → 0.4.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 (64) hide show
  1. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/.github/workflows/build.yml +9 -7
  2. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/.github/workflows/documentation.yml +3 -3
  3. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/.pre-commit-config.yaml +5 -5
  4. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/PKG-INFO +2 -2
  5. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/duties.py +2 -3
  6. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs.yml +1 -1
  7. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/__init__.py +1 -1
  8. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/backends/mkdocsbackend.py +3 -3
  9. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/buildcollector.py +0 -2
  10. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/buildcontext.py +0 -1
  11. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/commands/build_page.py +18 -59
  12. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/commands/serve.py +0 -1
  13. mkdocs_mknodes-0.4.6/mkdocs_mknodes/commands/utils.py +62 -0
  14. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/manual/root.py +6 -7
  15. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/manual/use_cases_section.py +0 -1
  16. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/mkdocsconfig.py +6 -9
  17. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/mknodesconfig.py +1 -1
  18. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/plugin/__init__.py +28 -14
  19. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/plugin/mkdocsbuilder.py +0 -1
  20. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/plugin/pluginconfig.py +9 -8
  21. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/pyproject.toml +8 -8
  22. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/tests/test_cli.py +0 -1
  23. mkdocs_mknodes-0.4.4/mkdocs_mknodes/project.py +0 -62
  24. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/.editorconfig +0 -0
  25. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/.github/README.md +0 -0
  26. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/.gitignore +0 -0
  27. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/LICENSE +0 -0
  28. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/README.md +0 -0
  29. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/configs/mkdocs_mkdocs.yml +0 -0
  30. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/configs/mkdocs_shared.yml +0 -0
  31. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/docs/assets/cli.gif +0 -0
  32. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/docs/build_process.jinja +0 -0
  33. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/docs/cli_index.jinja +0 -0
  34. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/docs/github_index.jinja +0 -0
  35. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/docs/index.jinja +0 -0
  36. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/docs/plugin_configuration.jinja +0 -0
  37. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/docs/use_case_by_config.jinja +0 -0
  38. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/docs/use_case_default_website.jinja +0 -0
  39. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/docs/use_cases_index.jinja +0 -0
  40. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/docs/why_should_i_use_mknodes.jinja +0 -0
  41. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/backends/__init__.py +0 -0
  42. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/backends/buildbackend.py +0 -0
  43. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/backends/markdownbackend.py +0 -0
  44. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/cli/__init__.py +0 -0
  45. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/cli/richstate.py +0 -0
  46. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/commands/__init__.py +0 -0
  47. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/manual/__init__.py +0 -0
  48. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/manual/cli_section.py +0 -0
  49. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/manual/get_started_section.py +0 -0
  50. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/manual/github_index.py +0 -0
  51. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/mkdefaultwebsite.py +0 -0
  52. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/paths.py +0 -0
  53. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
  54. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
  55. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/py.typed +0 -0
  56. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
  57. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
  58. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/mkdocs_mknodes.sublime-project +0 -0
  59. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/overrides/_dummy.txt +0 -0
  60. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/overrides/partials/actions.html +0 -0
  61. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/tests/__init__.py +0 -0
  62. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/tests/conftest.py +0 -0
  63. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/tests/data/objects.inv +0 -0
  64. {mkdocs_mknodes-0.4.4 → mkdocs_mknodes-0.4.6}/tests/test_build.py +0 -0
@@ -8,16 +8,18 @@ jobs:
8
8
  runs-on: ubuntu-latest
9
9
  strategy:
10
10
  matrix:
11
- python_version: ['3.11']
11
+ python_version: ['3.11', '3.12', '3.13']
12
12
 
13
13
  steps:
14
- - uses: actions/checkout@v3
14
+ - uses: actions/checkout@v4
15
15
  - name: Set up Python
16
- uses: actions/setup-python@v4
16
+ uses: actions/setup-python@v5
17
17
  with:
18
18
  python-version: ${{ matrix.python_version }}
19
+ - name: Install uv
20
+ uses: yezz123/setup-uv@v4
19
21
  - name: Setup Graphviz
20
- uses: ts-graphviz/setup-graphviz@v1
22
+ uses: ts-graphviz/setup-graphviz@v2
21
23
  - name: Install dependencies
22
24
  run: |
23
25
  python -m pip install --upgrade pip
@@ -44,11 +46,11 @@ jobs:
44
46
  id-token: write
45
47
  contents: write
46
48
  steps:
47
- - uses: actions/checkout@v3
49
+ - uses: actions/checkout@v4
48
50
  - name: Set up Python
49
- uses: actions/setup-python@v4
51
+ uses: actions/setup-python@v5
50
52
  with:
51
- python-version: '3.11'
53
+ python-version: '3.12'
52
54
  - name: Install dependencies
53
55
  shell: bash
54
56
  run: |
@@ -27,15 +27,15 @@ jobs:
27
27
  runs-on: ubuntu-latest
28
28
 
29
29
  steps:
30
- - uses: actions/checkout@v3
30
+ - uses: actions/checkout@v4
31
31
  with:
32
32
  fetch-depth: 0
33
33
  - name: Set up Python
34
- uses: actions/setup-python@v4
34
+ uses: actions/setup-python@v5
35
35
  with:
36
36
  python-version: '3.11'
37
37
  - name: Setup Graphviz
38
- uses: ts-graphviz/setup-graphviz@v1
38
+ uses: ts-graphviz/setup-graphviz@v2
39
39
  - name: Install dependencies
40
40
  run: |
41
41
  python -m pip install --upgrade pip
@@ -1,6 +1,6 @@
1
1
  default_language_version:
2
2
  python: python3.11
3
- default_stages: [commit]
3
+ default_stages: [pre-commit]
4
4
  repos:
5
5
  - repo: local
6
6
  hooks:
@@ -13,7 +13,7 @@ repos:
13
13
  pass_filenames: false
14
14
  always_run: true
15
15
  - repo: https://github.com/pre-commit/pre-commit-hooks
16
- rev: v4.5.0
16
+ rev: v5.0.0
17
17
  hooks:
18
18
  # - id: trailing-whitespace
19
19
  # - id: check-ast
@@ -29,20 +29,20 @@ repos:
29
29
  # https://pre-commit.com/hooks.html
30
30
 
31
31
  - repo: https://github.com/pre-commit/mirrors-mypy
32
- rev: v1.6.1
32
+ rev: v1.11.2
33
33
  hooks:
34
34
  - id: mypy
35
35
  # args: [--ignore-missing-imports]
36
36
  additional_dependencies: [mkdocs]
37
37
 
38
38
  - repo: https://github.com/charliermarsh/ruff-pre-commit
39
- rev: v0.1.5
39
+ rev: v0.6.9
40
40
  hooks:
41
41
  - id: ruff
42
42
  - id: ruff-format
43
43
 
44
44
  - repo: https://github.com/commitizen-tools/commitizen
45
- rev: 3.12.0
45
+ rev: v3.29.1
46
46
  hooks:
47
47
  - id: commitizen
48
48
  stages: [commit-msg]
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.3
2
2
  Name: mkdocs-mknodes
3
- Version: 0.4.4
3
+ Version: 0.4.6
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
@@ -42,9 +42,8 @@ def clean(ctx):
42
42
  def update(ctx, *args: str):
43
43
  """Update all environment packages using pip directly."""
44
44
  args_str = " " + " ".join(args) if args else ""
45
- requirements = ctx.run(UPDATE_CMD + args_str)
46
- requirements = "\n".join(requirements.split("\n")[1:])
47
- packages = [x["name"] for x in json.loads(requirements)]
45
+ reqs = ctx.run(UPDATE_CMD + args_str)
46
+ packages = [x["name"] for x in json.loads(reqs)]
48
47
  if packages:
49
48
  pkgs = " ".join(packages)
50
49
  print(f"Packages to update: {pkgs}")
@@ -51,7 +51,7 @@ theme:
51
51
  plugins:
52
52
  - search
53
53
  - mknodes:
54
- build_fn: mkdocs_mknodes.manual.root:build
54
+ build_fn: mkdocs_mknodes.manual.root:Build.build
55
55
  show_page_info: true
56
56
  global_resources: false
57
57
  - mkdocstrings:
@@ -1,4 +1,4 @@
1
- __version__ = "0.4.4"
1
+ __version__ = "0.4.6"
2
2
 
3
3
 
4
4
  from .mkdefaultwebsite import MkDefaultWebsite
@@ -4,13 +4,13 @@ import collections
4
4
  import os
5
5
  import pathlib
6
6
 
7
+ from jinjarope import serializefilters
7
8
  import markdown
8
-
9
9
  from mkdocs.config import config_options
10
10
  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
- from mknodes.utils import mergehelpers, pathhelpers, resources
13
+ from mknodes.utils import pathhelpers, resources
14
14
  import upath
15
15
 
16
16
  from mkdocs_mknodes import mkdocsconfig
@@ -123,7 +123,7 @@ class MkDocsBackend(buildbackend.BuildBackend):
123
123
  if ext_name not in self._config.markdown_extensions:
124
124
  logger.info("Adding %s to extensions", ext_name)
125
125
  self._config.markdown_extensions.append(ext_name)
126
- self._config.mdx_configs = mergehelpers.merge_dicts(
126
+ self._config.mdx_configs = serializefilters.merge(
127
127
  self._config.mdx_configs,
128
128
  extensions,
129
129
  )
@@ -6,11 +6,9 @@ import collections
6
6
  import itertools
7
7
  import pathlib
8
8
  import pprint
9
-
10
9
  from typing import TYPE_CHECKING
11
10
 
12
11
  import mknodes as mk
13
-
14
12
  from mknodes.utils import log, resources
15
13
 
16
14
  from mkdocs_mknodes import buildcontext
@@ -6,7 +6,6 @@ import collections
6
6
  import dataclasses
7
7
 
8
8
  import mknodes as mk
9
-
10
9
  from mknodes.info import contexts
11
10
  from mknodes.utils import log, resources
12
11
 
@@ -2,27 +2,22 @@
2
2
 
3
3
  from __future__ import annotations
4
4
 
5
- from collections.abc import Callable
6
- import functools
7
5
  import io
8
- import logging
9
6
  import os
10
- import time
11
-
12
- from typing import TYPE_CHECKING
7
+ from typing import TYPE_CHECKING, Any
13
8
  from urllib.parse import urljoin
14
9
 
15
- from mkdocs import utils
16
10
  from mkdocs.commands import build as mkdocs_build
17
11
  from mkdocs.config import load_config
18
- from mkdocs.exceptions import Abort, BuildError
19
12
  from mkdocs.plugins import get_plugin_logger
20
- from mkdocs.structure.files import InclusionLevel, _set_exclusions, get_files
13
+ from mkdocs.structure.files import InclusionLevel, get_files, set_exclusions
21
14
  from mkdocs.structure.nav import get_navigation
22
15
  from mkdocs.structure.pages import Page
23
16
  from mknodes.info import mkdocsconfigfile
24
17
  from mknodes.utils import pathhelpers, yamlhelpers
25
18
 
19
+ from mkdocs_mknodes.commands import utils
20
+
26
21
 
27
22
  if TYPE_CHECKING:
28
23
  from mkdocs.config.defaults import MkDocsConfig
@@ -37,7 +32,7 @@ def build(
37
32
  build_fn: str | None,
38
33
  site_dir: str | None = None,
39
34
  clone_depth: int = 100,
40
- **kwargs,
35
+ **kwargs: Any,
41
36
  ):
42
37
  """Build a MkNodes-based website.
43
38
 
@@ -68,50 +63,8 @@ def build(
68
63
  config.plugins.run_event("shutdown")
69
64
 
70
65
 
71
- def count_warnings(fn: Callable) -> Callable:
72
- @functools.wraps(fn)
73
- def wrapped(config: MkDocsConfig, *args, **kwargs):
74
- start = time.monotonic()
75
- warning_counter = utils.CountHandler()
76
- warning_counter.setLevel(logging.WARNING)
77
- if config.strict:
78
- logging.getLogger("mkdocs").addHandler(warning_counter)
79
- result = fn(config, *args, **kwargs)
80
- counts = warning_counter.get_counts()
81
- if counts:
82
- msg = ", ".join(f"{v} {k.lower()}s" for k, v in counts)
83
- msg = f"Aborted with {msg} in strict mode!"
84
- raise Abort(msg)
85
- duration = time.monotonic() - start
86
- logger.info("Documentation built in %.2f seconds", duration)
87
- logging.getLogger("mkdocs").removeHandler(warning_counter)
88
-
89
- return result
90
-
91
- return wrapped
92
-
93
-
94
- def handle_exceptions(fn: Callable) -> Callable:
95
- @functools.wraps(fn)
96
- def wrapped(config: MkDocsConfig, *args, **kwargs):
97
- try:
98
- return fn(config, *args, **kwargs)
99
- except Exception as e:
100
- # Run `build_error` plugin events.
101
- config.plugins.on_build_error(error=e)
102
- if isinstance(e, BuildError):
103
- msg = "Aborted with a BuildError!"
104
- logger.exception(msg)
105
- raise Abort(msg) from e
106
- raise
107
- # finally:
108
- # logging.getLogger("mkdocs").removeHandler(warning_counter)
109
-
110
- return wrapped
111
-
112
-
113
- @handle_exceptions
114
- @count_warnings
66
+ @utils.handle_exceptions
67
+ @utils.count_warnings
115
68
  def _build(
116
69
  config: MkDocsConfig,
117
70
  live_server_url: str | None = None,
@@ -127,7 +80,9 @@ def _build(
127
80
  live_server_url: An optional URL of the live server to use
128
81
  dirty: Do a dirty build
129
82
  """
130
- inclusion = InclusionLevel.all if live_server_url else InclusionLevel.is_included
83
+ inclusion = (
84
+ InclusionLevel.is_in_serve if live_server_url else InclusionLevel.is_included
85
+ )
131
86
  config = config.plugins.on_config(config)
132
87
  config.plugins.on_pre_build(config=config)
133
88
 
@@ -147,7 +102,7 @@ def _build(
147
102
  files.add_files_from_theme(env, config)
148
103
  files = config.plugins.on_files(files, config=config)
149
104
  # If plugins have added files without setting inclusion level, calculate it again.
150
- _set_exclusions(files._files, config)
105
+ set_exclusions(files._files, config)
151
106
  nav = get_navigation(files, config)
152
107
  # Run `nav` plugin events.
153
108
  nav = config.plugins.on_nav(nav, config=config, files=files)
@@ -155,8 +110,8 @@ def _build(
155
110
  excluded = []
156
111
  for file in files.documentation_pages(inclusion=inclusion):
157
112
  logger.debug("Reading: %s", file.src_uri)
158
- if file.page is None and file.inclusion.is_excluded():
159
- if live_server_url:
113
+ if file.page is None and file.inclusion.is_not_in_nav():
114
+ if live_server_url and file.inclusion.is_excluded():
160
115
  excluded.append(urljoin(live_server_url, file.url))
161
116
  Page(None, file, config)
162
117
  assert file.page is not None
@@ -165,7 +120,7 @@ def _build(
165
120
  excluded_str = "\n - ".join(excluded)
166
121
  logger.info(
167
122
  "The following pages are being built only for the preview "
168
- "but will be excluded from `mkdocs build` per `exclude_docs`:"
123
+ "but will be excluded from `mkdocs build` per `draft_docs` config:"
169
124
  "\n - %s",
170
125
  excluded_str,
171
126
  )
@@ -185,5 +140,9 @@ def _build(
185
140
  excl = file.inclusion.is_excluded()
186
141
  mkdocs_build._build_page(file.page, config, doc_files, nav, env, dirty, excl)
187
142
 
143
+ log_level = config.validation.links.anchors
144
+ for file in doc_files:
145
+ assert file.page is not None
146
+ file.page.validate_anchor_links(files=files, log_level=log_level)
188
147
  # Run `post_build` plugin events.
189
148
  config.plugins.on_post_build(config=config)
@@ -6,7 +6,6 @@ import os
6
6
  import pathlib
7
7
  import shutil
8
8
  import tempfile
9
-
10
9
  from typing import TYPE_CHECKING, Any, Literal
11
10
  from urllib.parse import urlsplit
12
11
 
@@ -0,0 +1,62 @@
1
+ """The Mkdocs Plugin."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from collections.abc import Callable
6
+ import functools
7
+ import logging
8
+ import time
9
+ from typing import TYPE_CHECKING
10
+
11
+ from mkdocs import utils
12
+ from mkdocs.exceptions import Abort, BuildError
13
+ from mkdocs.plugins import get_plugin_logger
14
+
15
+
16
+ if TYPE_CHECKING:
17
+ from mkdocs.config.defaults import MkDocsConfig
18
+
19
+
20
+ logger = get_plugin_logger(__name__)
21
+
22
+
23
+ def count_warnings(fn: Callable) -> Callable:
24
+ @functools.wraps(fn)
25
+ def wrapped(config: MkDocsConfig, *args, **kwargs):
26
+ start = time.monotonic()
27
+ warning_counter = utils.CountHandler()
28
+ warning_counter.setLevel(logging.WARNING)
29
+ if config.strict:
30
+ logging.getLogger("mkdocs").addHandler(warning_counter)
31
+ result = fn(config, *args, **kwargs)
32
+ counts = warning_counter.get_counts()
33
+ if counts:
34
+ msg = ", ".join(f"{v} {k.lower()}s" for k, v in counts)
35
+ msg = f"Aborted with {msg} in strict mode!"
36
+ raise Abort(msg)
37
+ duration = time.monotonic() - start
38
+ logger.info("Documentation built in %.2f seconds", duration)
39
+ logging.getLogger("mkdocs").removeHandler(warning_counter)
40
+
41
+ return result
42
+
43
+ return wrapped
44
+
45
+
46
+ def handle_exceptions(fn: Callable) -> Callable:
47
+ @functools.wraps(fn)
48
+ def wrapped(config: MkDocsConfig, *args, **kwargs):
49
+ try:
50
+ return fn(config, *args, **kwargs)
51
+ except Exception as e:
52
+ # Run `build_error` plugin events.
53
+ config.plugins.on_build_error(error=e)
54
+ if isinstance(e, BuildError):
55
+ msg = "Aborted with a BuildError!"
56
+ logger.exception(msg)
57
+ raise Abort(msg) from e
58
+ raise
59
+ # finally:
60
+ # logging.getLogger("mkdocs").removeHandler(warning_counter)
61
+
62
+ return wrapped
@@ -1,13 +1,18 @@
1
1
  from __future__ import annotations
2
2
 
3
3
  import mknodes as mk
4
-
5
4
  from mknodes.manual import dev_section
6
5
 
7
6
  from mkdocs_mknodes.manual import cli_section, get_started_section, use_cases_section
8
7
 
9
8
 
10
9
  class Build:
10
+ @classmethod
11
+ def build(cls, root, theme):
12
+ b = cls()
13
+ b.on_theme(theme)
14
+ return b.on_root(root)
15
+
11
16
  def on_theme(self, theme: mk.MaterialTheme):
12
17
  theme.error_page.content = mk.MkAdmonition("Page does not exist!")
13
18
  theme.content_area_width = 1300
@@ -23,9 +28,3 @@ class Build:
23
28
  nav += cli_section.nav
24
29
  nav += dev_section.nav
25
30
  return nav
26
-
27
-
28
- def build(project) -> mk.MkNav:
29
- build = Build()
30
- build.on_theme(project.theme)
31
- return build.on_root(project.root) or project.root
@@ -1,5 +1,4 @@
1
1
  import mknodes as mk
2
-
3
2
  from mknodes.info import mkdocsconfigfile
4
3
 
5
4
 
@@ -1,8 +1,7 @@
1
1
  from __future__ import annotations
2
2
 
3
- from collections.abc import Iterator, Mapping, Sequence
3
+ from collections.abc import Iterator, Mapping
4
4
  import contextlib
5
-
6
5
  from datetime import datetime
7
6
  import functools
8
7
  import io
@@ -12,10 +11,8 @@ import sys
12
11
  from typing import IO, Any
13
12
  from urllib import parse
14
13
 
15
- import jinja2
16
14
  import jinjarope
17
-
18
- from mkdocs.commands import get_deps
15
+ from mkdocs.__main__ import get_deps_command
19
16
  from mkdocs.config.defaults import MkDocsConfig
20
17
  from mkdocs.plugins import get_plugin_logger
21
18
  from mknodes.info import contexts
@@ -216,9 +213,9 @@ class Config:
216
213
  rel_path = edit_path
217
214
  return parse.urljoin(base_url, rel_path)
218
215
 
219
- def get_jinja_config(self) -> Sequence[jinja2.BaseLoader]:
216
+ def get_jinja_config(self) -> jinjarope.EnvConfig:
220
217
  cfg = self.plugin.config.get_jinja_config()
221
- cfg["loader"].append(jinjarope.FileSystemLoader(self.docs_dir))
218
+ cfg.loader |= jinjarope.FileSystemLoader(self.docs_dir)
222
219
  return cfg
223
220
 
224
221
  def get_install_candidates(self) -> list[str]:
@@ -226,7 +223,7 @@ class Config:
226
223
  path = "https://raw.githubusercontent.com/mkdocs/catalog/main/projects.yaml"
227
224
  buffer = io.StringIO()
228
225
  with contextlib.redirect_stdout(buffer):
229
- get_deps.get_deps(path, self._config.config_file_path)
226
+ get_deps_command(path, self._config.config_file_path)
230
227
  return [i for i in buffer.getvalue().split("\n") if i]
231
228
 
232
229
  def add_js(
@@ -255,4 +252,4 @@ class Config:
255
252
 
256
253
  if __name__ == "__main__":
257
254
  test = Config()
258
- print(test)
255
+ print(test.get_jinja_config())
@@ -42,7 +42,7 @@ class MkNodesConfig:
42
42
  """The directory containing the documentation markdown."""
43
43
  site_dir: pathlib.Path | str = "site"
44
44
  """The directory where the site will be built to"""
45
- copyright: str | None = None # noqa: A003
45
+ copyright: str | None = None
46
46
  """A copyright notice to add to the footer of documentation."""
47
47
  dev_addr: str = "127.0.0.1:8000"
48
48
  """The address on which to serve the live reloading docs server."""
@@ -9,11 +9,12 @@ from typing import TYPE_CHECKING, Literal
9
9
 
10
10
  from mkdocs.plugins import BasePlugin, get_plugin_logger
11
11
  import mknodes as mk
12
+ from mknodes.info import contexts, folderinfo, linkprovider, reporegistry
12
13
  from mknodes.utils import linkreplacer
13
14
 
14
15
  import jinjarope
15
16
 
16
- from mkdocs_mknodes import buildcollector, mkdocsconfig, project
17
+ from mkdocs_mknodes import buildcollector, mkdocsconfig
17
18
  from mkdocs_mknodes.backends import markdownbackend, mkdocsbackend
18
19
  from mkdocs_mknodes.plugin import pluginconfig, rewriteloader
19
20
 
@@ -54,17 +55,28 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
54
55
  """Create the project based on MkDocs config."""
55
56
  if not self.config.build_fn:
56
57
  return
57
- skin = mk.Theme.get_theme(
58
+ self.linkprovider = linkprovider.LinkProvider(
59
+ base_url=config.site_url or "",
60
+ use_directory_urls=config.use_directory_urls,
61
+ include_stdlib=True,
62
+ )
63
+ self.theme = mk.Theme.get_theme(
58
64
  theme_name=config.theme.name or "material",
59
65
  data=dict(config.theme),
60
66
  )
61
- self.project = project.Project(
62
- base_url=config.site_url or "",
63
- use_directory_urls=config.use_directory_urls,
64
- theme=skin,
65
- repo=self.config.repo_path,
67
+ git_repo = reporegistry.get_repo(
68
+ str(self.config.repo_path or "."),
66
69
  clone_depth=self.config.clone_depth,
67
70
  )
71
+ self.folderinfo = folderinfo.FolderInfo(git_repo.working_dir)
72
+ self.context = contexts.ProjectContext(
73
+ metadata=self.folderinfo.context,
74
+ git=self.folderinfo.git.context,
75
+ # github=self.folderinfo.github.context,
76
+ theme=self.theme.context,
77
+ links=self.linkprovider,
78
+ env_config=self.config.get_jinja_config(),
79
+ )
68
80
 
69
81
  def on_files(self, files: Files, config: MkDocsConfig) -> Files:
70
82
  """Create the node tree and write files to build folder.
@@ -81,21 +93,22 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
81
93
 
82
94
  logger.info("Generating pages...")
83
95
  build_fn = self.config.get_builder()
84
- build_fn(project=self.project)
96
+ self.root = mk.MkNav(context=self.context)
97
+ build_fn(theme=self.theme, root=self.root)
85
98
  logger.debug("Finished building page.")
86
99
  paths = [
87
100
  pathlib.Path(node.resolved_file_path).stem
88
- for _level, node in self.project.root.iter_nodes()
101
+ for _level, node in self.root.iter_nodes()
89
102
  if hasattr(node, "resolved_file_path")
90
103
  ]
91
- self.project.linkprovider.set_excludes(paths)
104
+ self.linkprovider.set_excludes(paths)
92
105
 
93
106
  # now we add our stuff to the MkDocs build environment
94
107
  cfg = mkdocsconfig.Config(config)
95
108
 
96
109
  logger.info("Updating MkDocs config metadata...")
97
- cfg.update_from_context(self.project.context)
98
- self.project.theme.adapt_extras(cfg.extra)
110
+ cfg.update_from_context(self.root.ctx)
111
+ self.theme.adapt_extras(cfg.extra)
99
112
 
100
113
  logger.info("Setting up build backends...")
101
114
  mkdocs_backend = mkdocsbackend.MkDocsBackend(
@@ -114,8 +127,8 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
114
127
  global_resources=self.config.global_resources,
115
128
  render_by_default=self.config.render_by_default,
116
129
  )
117
- self.build_info = collector.collect(self.project.root, self.project.theme)
118
- if nav_dict := self.project.root.nav.to_nav_dict():
130
+ self.build_info = collector.collect(self.root, self.theme)
131
+ if nav_dict := self.root.nav.to_nav_dict():
119
132
  match config.nav:
120
133
  case list():
121
134
  for k, v in nav_dict.items():
@@ -134,6 +147,7 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
134
147
  ) -> Navigation | None:
135
148
  """Populate LinkReplacer and build path->MkPage mapping for following steps."""
136
149
  for file_ in files:
150
+ assert file_.abs_src_path
137
151
  filename = pathlib.Path(file_.abs_src_path).name
138
152
  url = urllib.parse.unquote(file_.src_uri)
139
153
  self.link_replacer.mapping[filename].append(url)
@@ -1,7 +1,6 @@
1
1
  from __future__ import annotations
2
2
 
3
3
  import os
4
-
5
4
  from typing import TYPE_CHECKING
6
5
 
7
6
  from mkdocs.config.defaults import MkDocsConfig
@@ -5,6 +5,7 @@ from __future__ import annotations
5
5
  from collections.abc import Callable
6
6
  import functools
7
7
 
8
+ import jinjarope
8
9
  from mkdocs.config import base, config_options as c
9
10
  from mknodes.utils import classhelpers
10
11
 
@@ -125,12 +126,12 @@ class PluginConfig(base.Config):
125
126
  build_kwargs = self.kwargs or {}
126
127
  return functools.partial(build_fn, **build_kwargs)
127
128
 
128
- def get_jinja_config(self) -> dict:
129
- return dict(
130
- block_start_string=self.jinja_block_start_string,
131
- block_end_string=self.jinja_block_end_string,
132
- variable_start_string=self.jinja_variable_start_string,
133
- variable_end_string=self.jinja_variable_end_string,
134
- undefined=self.jinja_on_undefined,
135
- loader=self.jinja_loaders,
129
+ def get_jinja_config(self) -> jinjarope.EnvConfig:
130
+ return jinjarope.EnvConfig(
131
+ block_start_string=self.jinja_block_start_string or "{%",
132
+ block_end_string=self.jinja_block_end_string or "%}",
133
+ variable_start_string=self.jinja_variable_start_string or r"{{",
134
+ variable_end_string=self.jinja_variable_end_string or r"}}",
135
+ # undefined=self.jinja_on_undefined,
136
+ loader=jinjarope.loaders.from_json(self.jinja_loaders),
136
137
  )
@@ -45,19 +45,19 @@ test = "pytest -vv"
45
45
  test-cov-xml = "pytest --cov-report=xml"
46
46
  test-cov-html = "pytest --cov-report=html"
47
47
  lint = [
48
- "hatch run ruff --fix .",
49
- "hatch run ruff format .",
50
- "hatch run mypy mkdocs_mknodes/",
48
+ "hatch run ruff check --fix .",
49
+ "hatch run ruff format .",
50
+ "hatch run mypy mkdocs_mknodes/",
51
51
  ]
52
52
  lint-check = [
53
- "hatch run ruff .",
54
- "hatch run ruff format --check .",
55
- "hatch run mypy mkdocs_mknodes/",
53
+ "hatch run ruff check .",
54
+ "hatch run ruff format --check .",
55
+ "hatch run mypy mkdocs_mknodes/",
56
56
  ]
57
57
 
58
58
  docs-build-test = [
59
- "hatch run mkdocs build -v",
60
- "hatch run mknodes build -d ../site/mkdocs -p configs/mkdocs_mkdocs.yml -v --clone-depth 100",
59
+ "hatch run mkdocs build -v",
60
+ "hatch run mknodes build -d ../site/mkdocs -p configs/mkdocs_mkdocs.yml -v --clone-depth 100",
61
61
  ]
62
62
 
63
63
  [build-system]
@@ -2,7 +2,6 @@ from __future__ import annotations
2
2
 
3
3
  import pathlib
4
4
  import tempfile
5
-
6
5
  from unittest import mock
7
6
 
8
7
  from typer.testing import CliRunner
@@ -1,62 +0,0 @@
1
- """MkNodes project."""
2
-
3
- from __future__ import annotations
4
-
5
- import os
6
-
7
- from typing import Generic, TypeVar
8
-
9
- from mknodes.info import contexts, folderinfo, linkprovider, reporegistry
10
- from mknodes.navs import mknav
11
- from mknodes.theme import theme as theme_
12
-
13
-
14
- T = TypeVar("T", bound=theme_.Theme)
15
-
16
-
17
- class Project(Generic[T]):
18
- """MkNodes Project."""
19
-
20
- def __init__(
21
- self,
22
- theme: T,
23
- repo: str | os.PathLike | None | folderinfo.FolderInfo = None,
24
- base_url: str = "",
25
- use_directory_urls: bool = True,
26
- clone_depth: int = 100,
27
- ):
28
- """The main project to create a website.
29
-
30
- Arguments:
31
- theme: The theme to use
32
- repo: Path to the git repository
33
- base_url: Base url of the website
34
- use_directory_urls: Whether urls are in directory-style
35
- clone_depth: Amount of commits to clone in case repository is remote.
36
- """
37
- self.linkprovider = linkprovider.LinkProvider(
38
- base_url=base_url,
39
- use_directory_urls=use_directory_urls,
40
- include_stdlib=True,
41
- )
42
- self.theme: T = theme
43
- git_repo = reporegistry.get_repo(str(repo or "."), clone_depth=clone_depth)
44
- self.folderinfo = folderinfo.FolderInfo(git_repo.working_dir)
45
- self.context = contexts.ProjectContext(
46
- metadata=self.folderinfo.context,
47
- git=self.folderinfo.git.context,
48
- # github=self.folderinfo.github.context,
49
- theme=self.theme.context,
50
- links=self.linkprovider,
51
- env_config={},
52
- )
53
- self._root = mknav.MkNav(context=self.context)
54
-
55
- @property
56
- def root(self) -> mknav.MkNav:
57
- return self._root
58
-
59
- @root.setter
60
- def root(self, nav: mknav.MkNav):
61
- self._root = nav
62
- nav._ctx = self.context
File without changes
File without changes