mkdocs-mknodes 0.7.7__tar.gz → 1.0.2__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.
- mkdocs_mknodes-1.0.2/LICENSE +22 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/PKG-INFO +3 -2
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/__init__.py +2 -2
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/appconfig/appconfig.py +2 -3
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/appconfig/validationconfig.py +7 -7
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/backends/buildbackend.py +3 -3
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/backends/mkdocsbackend.py +4 -2
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/buildcollector.py +43 -34
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/cli/__init__.py +19 -13
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/commands/serve.py +2 -2
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/manual/use_cases_section.py +1 -1
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/mkdocsconfig.py +1 -1
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/plugin/__init__.py +22 -13
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/plugin/mkdocsbuilder.py +3 -3
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/plugin/mknodesconfig.py +7 -7
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/pyproject.toml +35 -9
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/README.md +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/appconfig/__init__.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/appconfig/base.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/appconfig/jinjaconfig.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/appconfig/themeconfig.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/appconfig/upathtype.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/backends/__init__.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/backends/markdownbackend.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/buildcontext.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/builders/__init__.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/builders/configbuilder.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/cli/richstate.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/commands/__init__.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/commands/build_page.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/commands/utils.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/liveserver.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/manual/__init__.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/manual/cli_section.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/manual/get_started_section.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/manual/github_index.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/manual/root.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/mkdefaultwebsite.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/paths.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/plugin/pluginconfig.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/py.typed +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
- {mkdocs_mknodes-0.7.7 → mkdocs_mknodes-1.0.2}/mkdocs_mknodes/telemetry.py +0 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023, Philipp Temminghoff
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: mkdocs-mknodes
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 1.0.2
|
|
4
4
|
Summary: Don't write docs. Code them.
|
|
5
5
|
Keywords: docs,docstrings,documentation,framework,internet,markdown
|
|
6
6
|
Author: Philipp Temminghoff
|
|
7
7
|
Author-email: Philipp Temminghoff <philipptemminghoff@gmail.com>
|
|
8
8
|
License-Expression: MIT
|
|
9
|
+
License-File: LICENSE
|
|
9
10
|
Classifier: Development Status :: 4 - Beta
|
|
10
11
|
Classifier: Intended Audience :: Developers
|
|
11
12
|
Classifier: Operating System :: OS Independent
|
|
@@ -24,7 +25,7 @@ Requires-Dist: jinja2
|
|
|
24
25
|
Requires-Dist: jinjarope
|
|
25
26
|
Requires-Dist: logfire
|
|
26
27
|
Requires-Dist: mkdocs>=1.5
|
|
27
|
-
Requires-Dist: mknodes
|
|
28
|
+
Requires-Dist: mknodes>=2.0.0
|
|
28
29
|
Requires-Dist: opentelemetry-instrumentation-jinja2
|
|
29
30
|
Requires-Dist: opentelemetry-instrumentation-urllib
|
|
30
31
|
Requires-Dist: opentelemetry-instrumentation-urllib3
|
|
@@ -7,10 +7,10 @@ telemetry.setup_logfire()
|
|
|
7
7
|
__version__ = version("mkdocs-mknodes")
|
|
8
8
|
|
|
9
9
|
|
|
10
|
-
def parse(root, theme, pages):
|
|
10
|
+
async def parse(root, theme, pages):
|
|
11
11
|
from mknodes.navs.navparser import parse_new_style_nav
|
|
12
12
|
|
|
13
|
-
parse_new_style_nav(root, pages)
|
|
13
|
+
await parse_new_style_nav(root, pages)
|
|
14
14
|
return root
|
|
15
15
|
|
|
16
16
|
|
|
@@ -315,7 +315,7 @@ class AppConfig(ConfigFile):
|
|
|
315
315
|
|
|
316
316
|
Allows setting up loaders, extensions and the render behavior.
|
|
317
317
|
"""
|
|
318
|
-
docs_dir:
|
|
318
|
+
docs_dir: str = Field("docs")
|
|
319
319
|
"""Directory containing documentation markdown source files.
|
|
320
320
|
|
|
321
321
|
!!! info "Path Resolution"
|
|
@@ -335,7 +335,7 @@ class AppConfig(ConfigFile):
|
|
|
335
335
|
```
|
|
336
336
|
"""
|
|
337
337
|
|
|
338
|
-
site_dir:
|
|
338
|
+
site_dir: str = Field("site")
|
|
339
339
|
"""Directory where the built HTML site will be created.
|
|
340
340
|
|
|
341
341
|
!!! warning "Version Control"
|
|
@@ -816,7 +816,6 @@ if __name__ == "__main__":
|
|
|
816
816
|
]
|
|
817
817
|
for url in tests:
|
|
818
818
|
config = AppConfig.from_yaml_file(url)
|
|
819
|
-
config.theme = {"name": "xyz", "override_dir": "overrides"}
|
|
820
819
|
|
|
821
820
|
devtools.debug(config.theme)
|
|
822
821
|
print(config.theme, type(config.theme))
|
|
@@ -19,16 +19,16 @@ class ValidationLevelForAbsolute(Enum):
|
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
class Nav(BaseModel):
|
|
22
|
-
omitted_files: ValidationLevel | None =
|
|
23
|
-
not_found: ValidationLevel | None =
|
|
24
|
-
absolute_links: ValidationLevel | None =
|
|
22
|
+
omitted_files: ValidationLevel | None = ValidationLevel.info
|
|
23
|
+
not_found: ValidationLevel | None = ValidationLevel.warn
|
|
24
|
+
absolute_links: ValidationLevel | None = ValidationLevel.info
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
class Links(BaseModel):
|
|
28
|
-
not_found: ValidationLevel | None =
|
|
29
|
-
anchors: ValidationLevel | None =
|
|
30
|
-
absolute_links: ValidationLevelForAbsolute | None =
|
|
31
|
-
unrecognized_links: ValidationLevel | None =
|
|
28
|
+
not_found: ValidationLevel | None = ValidationLevel.warn
|
|
29
|
+
anchors: ValidationLevel | None = ValidationLevel.info
|
|
30
|
+
absolute_links: ValidationLevelForAbsolute | None = ValidationLevelForAbsolute.info
|
|
31
|
+
unrecognized_links: ValidationLevel | None = ValidationLevel.info
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
class ValidationConfig(BaseModel):
|
|
@@ -13,7 +13,7 @@ logger = log.get_logger(__name__)
|
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
class BuildBackend:
|
|
16
|
-
def collect(
|
|
16
|
+
async def collect(
|
|
17
17
|
self,
|
|
18
18
|
files: dict[str, str | bytes],
|
|
19
19
|
reqs: resources.Resources,
|
|
@@ -23,7 +23,7 @@ class BuildBackend:
|
|
|
23
23
|
self.write_js_links(reqs.js_links)
|
|
24
24
|
self.write_js_files(reqs.js_files)
|
|
25
25
|
self.write_css(reqs.css)
|
|
26
|
-
self.write_templates(templates)
|
|
26
|
+
await self.write_templates(templates)
|
|
27
27
|
self.write_files(files)
|
|
28
28
|
self.write_assets(reqs.assets)
|
|
29
29
|
|
|
@@ -45,7 +45,7 @@ class BuildBackend:
|
|
|
45
45
|
def collect_extensions(self, extensions):
|
|
46
46
|
pass
|
|
47
47
|
|
|
48
|
-
def write_templates(self, templates):
|
|
48
|
+
async def write_templates(self, templates):
|
|
49
49
|
pass
|
|
50
50
|
|
|
51
51
|
def write_assets(self, assets):
|
|
@@ -9,6 +9,7 @@ import markdown
|
|
|
9
9
|
from mkdocs.config import config_options
|
|
10
10
|
from mkdocs.config.defaults import MkDocsConfig
|
|
11
11
|
from mkdocs.structure import files as files_
|
|
12
|
+
import mknodes as mk
|
|
12
13
|
from mknodes.utils import resources
|
|
13
14
|
import upath
|
|
14
15
|
from upathtools import helpers
|
|
@@ -132,14 +133,15 @@ class MkDocsBackend(buildbackend.BuildBackend):
|
|
|
132
133
|
extensions,
|
|
133
134
|
)
|
|
134
135
|
|
|
135
|
-
def write_templates(self, templates):
|
|
136
|
+
async def write_templates(self, templates: list[mk.PageTemplate]):
|
|
136
137
|
if not self._config.theme.custom_dir:
|
|
137
138
|
logger.warning("Cannot write template. No custom_dir set in config.")
|
|
138
139
|
return
|
|
139
140
|
path = upath.UPath(self._config.theme.custom_dir)
|
|
140
141
|
for template in templates:
|
|
141
142
|
md = self._get_parser()
|
|
142
|
-
if html := template.build_html(md):
|
|
143
|
+
if html := await template.build_html(md):
|
|
144
|
+
assert template.filename
|
|
143
145
|
target_path = path / template.filename
|
|
144
146
|
logger.info("Creating %s...", target_path.as_posix())
|
|
145
147
|
helpers.write_file(html, target_path)
|
|
@@ -66,9 +66,10 @@ def update_page_template(page: mk.MkPage):
|
|
|
66
66
|
html_path = node_path.with_suffix(".html").as_posix()
|
|
67
67
|
logger.debug("Updated template for MkPage %r: %r", page.title, html_path)
|
|
68
68
|
page.metadata.template = html_path
|
|
69
|
-
page.template
|
|
70
|
-
|
|
71
|
-
|
|
69
|
+
if page.template:
|
|
70
|
+
page.template.filename = html_path
|
|
71
|
+
if extends := _get_extends_from_parent(page):
|
|
72
|
+
page.template.extends = extends
|
|
72
73
|
|
|
73
74
|
|
|
74
75
|
def update_nav_template(nav: mk.MkNav):
|
|
@@ -87,9 +88,9 @@ def update_nav_template(nav: mk.MkNav):
|
|
|
87
88
|
nav.page_template.extends = extends
|
|
88
89
|
|
|
89
90
|
|
|
90
|
-
def process_resources(page: mk.MkPage) -> resources.Resources:
|
|
91
|
+
async def process_resources(page: mk.MkPage) -> resources.Resources:
|
|
91
92
|
"""Add resources from page to its template and return the "filtered" resources."""
|
|
92
|
-
req = page.get_resources()
|
|
93
|
+
req = await page.get_resources()
|
|
93
94
|
js_reqs: list[resources.JSFile] = []
|
|
94
95
|
prefix = "../" * (len(page.resolved_parts) + 1)
|
|
95
96
|
for i in req.js:
|
|
@@ -113,11 +114,13 @@ def process_resources(page: mk.MkPage) -> resources.Resources:
|
|
|
113
114
|
for lib in libs:
|
|
114
115
|
msg = f"Adding {lib.link!r} lib to {page.resolved_file_path!r} template"
|
|
115
116
|
logger.info(msg)
|
|
116
|
-
page.template
|
|
117
|
+
if page.template:
|
|
118
|
+
page.template.libs.add_script_file(lib)
|
|
117
119
|
for lib in non_libs:
|
|
118
120
|
msg = f"Adding {lib.link!r} script to {page.resolved_file_path!r} template"
|
|
119
121
|
logger.info(msg)
|
|
120
|
-
page.template
|
|
122
|
+
if page.template:
|
|
123
|
+
page.template.scripts.add_script_file(lib)
|
|
121
124
|
css_reqs: list[resources.CSSFile] = []
|
|
122
125
|
for css_item in req.css:
|
|
123
126
|
if isinstance(css_item, resources.CSSText):
|
|
@@ -131,7 +134,8 @@ def process_resources(page: mk.MkPage) -> resources.Resources:
|
|
|
131
134
|
for css_ in css_reqs:
|
|
132
135
|
msg = f"Adding {css_.link!r} stylesheet to {page.resolved_file_path!r} template"
|
|
133
136
|
logger.info(msg)
|
|
134
|
-
page.template
|
|
137
|
+
if page.template:
|
|
138
|
+
page.template.styles.add_stylesheet(css_)
|
|
135
139
|
return req
|
|
136
140
|
|
|
137
141
|
|
|
@@ -177,7 +181,7 @@ class BuildCollector:
|
|
|
177
181
|
self.resources = resources.Resources()
|
|
178
182
|
self.mapping: dict[str, mk.MkPage | mk.MkNav] = {}
|
|
179
183
|
|
|
180
|
-
def collect(self, root: mk.MkNode, theme: mk.Theme):
|
|
184
|
+
async def collect(self, root: mk.MkNode, theme: mk.Theme):
|
|
181
185
|
"""Collect build stuff from given node + theme.
|
|
182
186
|
|
|
183
187
|
Args:
|
|
@@ -190,18 +194,18 @@ class BuildCollector:
|
|
|
190
194
|
self.extra_files |= node.files
|
|
191
195
|
match node:
|
|
192
196
|
case mk.MkPage() as page:
|
|
193
|
-
self.collect_page(page)
|
|
197
|
+
await self.collect_page(page)
|
|
194
198
|
case mk.MkNav() as nav:
|
|
195
|
-
self.collect_nav(nav)
|
|
199
|
+
await self.collect_nav(nav)
|
|
196
200
|
for node in self.mapping.values():
|
|
197
201
|
match node:
|
|
198
202
|
case mk.MkPage() as page:
|
|
199
|
-
self.render_page(page)
|
|
203
|
+
await self.render_page(page)
|
|
200
204
|
case mk.MkNav() as nav:
|
|
201
|
-
self.render_nav(nav)
|
|
205
|
+
await self.render_nav(nav)
|
|
202
206
|
# theme
|
|
203
207
|
logger.debug("Collecting theme resources...")
|
|
204
|
-
reqs = theme.get_resources()
|
|
208
|
+
reqs = await theme.get_resources()
|
|
205
209
|
self.resources.merge(reqs)
|
|
206
210
|
logger.debug("Adapting collected extensions to theme...")
|
|
207
211
|
theme.adapt_extensions(self.resources.markdown_extensions)
|
|
@@ -210,23 +214,23 @@ class BuildCollector:
|
|
|
210
214
|
i.template if isinstance(i, mk.MkPage) else i.page_template
|
|
211
215
|
for i in self.mapping.values()
|
|
212
216
|
]
|
|
213
|
-
vals = theme.templates
|
|
217
|
+
vals = theme.templates
|
|
214
218
|
templates += list(vals)
|
|
215
|
-
|
|
219
|
+
final_templates = [i for i in templates if i]
|
|
216
220
|
build_files = self.node_files | self.extra_files
|
|
217
221
|
for backend in self.backends:
|
|
218
222
|
logger.info("%s: Writing data..", type(backend).__name__)
|
|
219
|
-
backend.collect(build_files, self.resources,
|
|
223
|
+
await backend.collect(build_files, self.resources, final_templates)
|
|
220
224
|
return buildcontext.BuildContext(
|
|
221
225
|
page_mapping=self.mapping,
|
|
222
226
|
resources=self.resources,
|
|
223
227
|
node_counter=self.node_counter,
|
|
224
228
|
build_files=build_files,
|
|
225
|
-
templates=
|
|
229
|
+
templates=final_templates,
|
|
226
230
|
)
|
|
227
231
|
|
|
228
232
|
@logfire.instrument("collect_page: {page.title}")
|
|
229
|
-
def collect_page(self, page: mk.MkPage):
|
|
233
|
+
async def collect_page(self, page: mk.MkPage):
|
|
230
234
|
"""Preprocess page and collect its data.
|
|
231
235
|
|
|
232
236
|
Args:
|
|
@@ -236,7 +240,7 @@ class BuildCollector:
|
|
|
236
240
|
return
|
|
237
241
|
path = page.resolved_file_path
|
|
238
242
|
self.mapping[path] = page
|
|
239
|
-
req = page.get_resources() if self.global_resources else process_resources(page)
|
|
243
|
+
req = await page.get_resources() if self.global_resources else await process_resources(page)
|
|
240
244
|
self.resources.merge(req)
|
|
241
245
|
update_page_template(page)
|
|
242
246
|
show_info = page.resolved_metadata.get("show_page_info")
|
|
@@ -245,23 +249,23 @@ class BuildCollector:
|
|
|
245
249
|
add_page_info(page, req)
|
|
246
250
|
|
|
247
251
|
@logfire.instrument("render_page: {page.title}")
|
|
248
|
-
def render_page(self, page: mk.MkPage):
|
|
252
|
+
async def render_page(self, page: mk.MkPage):
|
|
249
253
|
"""Convert a page to markdown/HTML.
|
|
250
254
|
|
|
251
255
|
Args:
|
|
252
256
|
page: Page to render.
|
|
253
257
|
"""
|
|
254
|
-
md = page.to_markdown()
|
|
258
|
+
md = await page.to_markdown()
|
|
255
259
|
do_render = self.render_by_default
|
|
256
260
|
if (render := page.metadata.get("render_macros")) is not None:
|
|
257
261
|
do_render = render
|
|
258
262
|
if do_render:
|
|
259
|
-
md = page.env.
|
|
263
|
+
md = await page.env.render_string_async(md)
|
|
260
264
|
|
|
261
265
|
self.node_files[page.resolved_file_path] = md
|
|
262
266
|
|
|
263
267
|
@logfire.instrument("collect_nav: {nav.title}")
|
|
264
|
-
def collect_nav(self, nav: mk.MkNav):
|
|
268
|
+
async def collect_nav(self, nav: mk.MkNav):
|
|
265
269
|
"""Preprocess nav and collect its data.
|
|
266
270
|
|
|
267
271
|
Args:
|
|
@@ -270,18 +274,18 @@ class BuildCollector:
|
|
|
270
274
|
logger.info("Processing section %r...", nav.title or "[ROOT]")
|
|
271
275
|
path = nav.resolved_file_path
|
|
272
276
|
self.mapping[path] = nav
|
|
273
|
-
req = nav.get_node_resources()
|
|
277
|
+
req = await nav.get_node_resources()
|
|
274
278
|
self.resources.merge(req)
|
|
275
279
|
update_nav_template(nav)
|
|
276
280
|
|
|
277
281
|
@logfire.instrument("render_nav: {nav.title}")
|
|
278
|
-
def render_nav(self, nav: mk.MkNav):
|
|
282
|
+
async def render_nav(self, nav: mk.MkNav):
|
|
279
283
|
"""Convert a nav to markdown/HTML.
|
|
280
284
|
|
|
281
285
|
Args:
|
|
282
286
|
nav: Nav to render.
|
|
283
287
|
"""
|
|
284
|
-
md = nav.to_markdown()
|
|
288
|
+
md = await nav.to_markdown()
|
|
285
289
|
self.node_files[nav.resolved_file_path] = md
|
|
286
290
|
|
|
287
291
|
|
|
@@ -289,10 +293,15 @@ if __name__ == "__main__":
|
|
|
289
293
|
theme = mk.MaterialTheme()
|
|
290
294
|
from mkdocs_mknodes.manual import root
|
|
291
295
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
296
|
+
async def main():
|
|
297
|
+
log.basic()
|
|
298
|
+
build = root.Build()
|
|
299
|
+
nav = mk.MkNav.with_context()
|
|
300
|
+
build.on_root(nav)
|
|
301
|
+
collector = BuildCollector([])
|
|
302
|
+
ctx = await collector.collect(nav, mk.MaterialTheme())
|
|
303
|
+
print(ctx)
|
|
304
|
+
|
|
305
|
+
import asyncio
|
|
306
|
+
|
|
307
|
+
asyncio.run(main())
|
|
@@ -157,19 +157,25 @@ def create_config(
|
|
|
157
157
|
builder = classhelpers.to_callable(build_fn)
|
|
158
158
|
builder(context=nav.ctx)
|
|
159
159
|
collector = buildcollector.BuildCollector([])
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
160
|
+
|
|
161
|
+
async def main():
|
|
162
|
+
info = await collector.collect(nav, skin)
|
|
163
|
+
resources = info.resources
|
|
164
|
+
info = nav.ctx.metadata
|
|
165
|
+
if social := info.social_info:
|
|
166
|
+
config.extra["social"] = social # type: ignore[index]
|
|
167
|
+
config.markdown_extensions = resources.markdown_extensions
|
|
168
|
+
config.repo_path = info.repository_url
|
|
169
|
+
config.site_description = info.summary
|
|
170
|
+
config.site_name = info.distribution_name
|
|
171
|
+
config.site_author = info.author_name
|
|
172
|
+
config.copyright = f"Copyright © {datetime.now().year} {info.author_name}"
|
|
173
|
+
result = yamling.dump_yaml(config.model_dump(exclude_unset=True, exclude_defaults=True))
|
|
174
|
+
print(result)
|
|
175
|
+
|
|
176
|
+
import asyncio
|
|
177
|
+
|
|
178
|
+
asyncio.run(main())
|
|
173
179
|
|
|
174
180
|
|
|
175
181
|
if __name__ == "__main__":
|
|
@@ -174,10 +174,10 @@ def _serve(
|
|
|
174
174
|
server.watch(d)
|
|
175
175
|
|
|
176
176
|
# Run `serve` plugin events.
|
|
177
|
-
|
|
177
|
+
mkdocs_server = config.plugins.on_serve(server, config=config, builder=builder) # type: ignore[arg-type]
|
|
178
178
|
|
|
179
179
|
for item in config.watch:
|
|
180
|
-
|
|
180
|
+
mkdocs_server.watch(item)
|
|
181
181
|
|
|
182
182
|
try:
|
|
183
183
|
server.serve()
|
|
@@ -14,6 +14,6 @@ def _(page: mk.MkPage):
|
|
|
14
14
|
@nav.route.page("Creating a website via config", hide="toc")
|
|
15
15
|
def _(page: mk.MkPage):
|
|
16
16
|
"""Create the "Creating a sample website" MkPage."""
|
|
17
|
-
config = pathlib.Path("configs/mkdocs_mkdocs.yml").read_text()
|
|
17
|
+
config = pathlib.Path("configs/mkdocs_mkdocs.yml").read_text("utf-8")
|
|
18
18
|
variables = {"config": config}
|
|
19
19
|
page += mk.MkTemplate("use_case_default_website.jinja", variables=variables)
|
|
@@ -41,7 +41,7 @@ def _open_config_file(
|
|
|
41
41
|
"""
|
|
42
42
|
match config_file:
|
|
43
43
|
case None:
|
|
44
|
-
paths_to_try = [pathlib.Path("mkdocs.yml")]
|
|
44
|
+
paths_to_try: list[pathlib.Path] | None = [pathlib.Path("mkdocs.yml")]
|
|
45
45
|
case str() | os.PathLike():
|
|
46
46
|
paths_to_try = [pathlib.Path(config_file)]
|
|
47
47
|
case _ if getattr(config_file, "closed", False):
|
|
@@ -5,8 +5,8 @@ from __future__ import annotations
|
|
|
5
5
|
import pathlib
|
|
6
6
|
import urllib.parse
|
|
7
7
|
import tempfile
|
|
8
|
-
from typing import TYPE_CHECKING, Literal
|
|
9
|
-
|
|
8
|
+
from typing import TYPE_CHECKING, Any, Literal
|
|
9
|
+
from anyenv import run_sync
|
|
10
10
|
from mkdocs.plugins import BasePlugin
|
|
11
11
|
import mknodes as mk
|
|
12
12
|
from mknodes.info import contexts, folderinfo, linkprovider, reporegistry
|
|
@@ -16,6 +16,7 @@ import jinjarope
|
|
|
16
16
|
|
|
17
17
|
from mkdocs_mknodes import buildcollector, mkdocsconfig, telemetry
|
|
18
18
|
from mkdocs_mknodes.backends import markdownbackend, mkdocsbackend
|
|
19
|
+
from mkdocs_mknodes.buildcontext import BuildContext
|
|
19
20
|
from mkdocs_mknodes.plugin import pluginconfig, rewriteloader
|
|
20
21
|
|
|
21
22
|
if TYPE_CHECKING:
|
|
@@ -35,17 +36,18 @@ CommandStr = Literal["build", "serve", "gh-deploy"]
|
|
|
35
36
|
|
|
36
37
|
|
|
37
38
|
class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
|
|
38
|
-
def __init__(self, **kwargs):
|
|
39
|
+
def __init__(self, **kwargs: Any) -> None:
|
|
39
40
|
super().__init__(**kwargs)
|
|
40
41
|
self.link_replacer = linkreplacer.LinkReplacer()
|
|
41
42
|
logger.debug("Finished initializing plugin")
|
|
42
|
-
self.build_folder = None
|
|
43
|
-
self._dir = None
|
|
44
|
-
self.linkprovider = None
|
|
43
|
+
self.build_folder: pathlib.Path | None = None
|
|
44
|
+
self._dir: tempfile.TemporaryDirectory | None = None
|
|
45
|
+
self.linkprovider: linkprovider.LinkProvider | None = None
|
|
45
46
|
self.theme = None
|
|
46
|
-
self.
|
|
47
|
+
self.build_info: BuildContext | None = None
|
|
48
|
+
self.folderinfo: folderinfo.FolderInfo | None = None
|
|
47
49
|
self.context = None
|
|
48
|
-
self.root = None
|
|
50
|
+
self.root: mk.MkNav | None = None
|
|
49
51
|
|
|
50
52
|
def on_startup(self, *, command: CommandStr, dirty: bool):
|
|
51
53
|
"""Activates new-style MkDocs plugin lifecycle."""
|
|
@@ -55,12 +57,13 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
|
|
|
55
57
|
if self.config.build_folder:
|
|
56
58
|
self.build_folder = pathlib.Path(self.config.build_folder)
|
|
57
59
|
else:
|
|
58
|
-
|
|
60
|
+
temp_dir = tempfile.TemporaryDirectory(
|
|
59
61
|
prefix="mknodes_",
|
|
60
62
|
ignore_cleanup_errors=True,
|
|
61
63
|
)
|
|
62
|
-
self.
|
|
63
|
-
|
|
64
|
+
self._dir = temp_dir
|
|
65
|
+
self.build_folder = pathlib.Path(temp_dir.name)
|
|
66
|
+
logger.debug("Creating temporary dir %s", temp_dir.name)
|
|
64
67
|
|
|
65
68
|
if not self.config.build_fn:
|
|
66
69
|
return
|
|
@@ -77,6 +80,7 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
|
|
|
77
80
|
str(self.config.repo_path or "."),
|
|
78
81
|
clone_depth=self.config.clone_depth,
|
|
79
82
|
)
|
|
83
|
+
assert self.theme
|
|
80
84
|
self.folderinfo = folderinfo.FolderInfo(git_repo.working_dir)
|
|
81
85
|
self.context = contexts.ProjectContext(
|
|
82
86
|
metadata=self.folderinfo.context,
|
|
@@ -103,13 +107,15 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
|
|
|
103
107
|
logger.info("Generating pages...")
|
|
104
108
|
build_fn = self.config.get_builder()
|
|
105
109
|
self.root = mk.MkNav(context=self.context)
|
|
110
|
+
assert self.root
|
|
106
111
|
build_fn(theme=self.theme, root=self.root)
|
|
107
112
|
logger.debug("Finished building page.")
|
|
108
113
|
paths = [
|
|
109
114
|
pathlib.Path(node.resolved_file_path).stem
|
|
110
115
|
for _level, node in self.root.iter_nodes()
|
|
111
|
-
if
|
|
116
|
+
if isinstance(node, mk.MkPage | mk.MkNav)
|
|
112
117
|
]
|
|
118
|
+
assert self.linkprovider
|
|
113
119
|
self.linkprovider.set_excludes(paths)
|
|
114
120
|
|
|
115
121
|
# now we add our stuff to the MkDocs build environment
|
|
@@ -117,6 +123,7 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
|
|
|
117
123
|
|
|
118
124
|
logger.info("Updating MkDocs config metadata...")
|
|
119
125
|
cfg.update_from_context(self.root.ctx)
|
|
126
|
+
assert self.theme
|
|
120
127
|
self.theme.adapt_extras(cfg.extra)
|
|
121
128
|
|
|
122
129
|
logger.info("Setting up build backends...")
|
|
@@ -136,7 +143,7 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
|
|
|
136
143
|
global_resources=self.config.global_resources,
|
|
137
144
|
render_by_default=self.config.render_by_default,
|
|
138
145
|
)
|
|
139
|
-
self.build_info = collector.collect(self.root, self.theme)
|
|
146
|
+
self.build_info = run_sync(collector.collect(self.root, self.theme))
|
|
140
147
|
if nav_dict := self.root.nav.to_nav_dict():
|
|
141
148
|
match config.nav:
|
|
142
149
|
case list():
|
|
@@ -192,6 +199,7 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
|
|
|
192
199
|
files: Files,
|
|
193
200
|
) -> Page | None:
|
|
194
201
|
"""During this phase we set the edit paths."""
|
|
202
|
+
assert self.build_info
|
|
195
203
|
node = self.build_info.page_mapping.get(page.file.src_uri)
|
|
196
204
|
edit_path = node._edit_path if isinstance(node, mk.MkPage) else None
|
|
197
205
|
cfg = mkdocsconfig.Config(config)
|
|
@@ -216,6 +224,7 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
|
|
|
216
224
|
if not config.theme.custom_dir or not self.config.build_fn:
|
|
217
225
|
return
|
|
218
226
|
if self.config.auto_delete_generated_templates:
|
|
227
|
+
assert self.build_info
|
|
219
228
|
logger.debug("Deleting page templates...")
|
|
220
229
|
for template in self.build_info.templates:
|
|
221
230
|
assert template.filename
|
|
@@ -101,12 +101,12 @@ class MkDocsBuilder:
|
|
|
101
101
|
mkpage.resolved_file_path,
|
|
102
102
|
inclusion_level=files_.InclusionLevel.UNDEFINED,
|
|
103
103
|
)
|
|
104
|
-
|
|
104
|
+
mkdocs_page = MkDocsPage(mkpage, file, self._config)
|
|
105
105
|
|
|
106
106
|
if run_event_hooks:
|
|
107
|
-
self._config._current_page =
|
|
107
|
+
self._config._current_page = mkdocs_page
|
|
108
108
|
page = self._config.plugins.on_pre_page(
|
|
109
|
-
|
|
109
|
+
mkdocs_page,
|
|
110
110
|
config=self._config,
|
|
111
111
|
files=self.mk_files,
|
|
112
112
|
)
|
|
@@ -43,7 +43,7 @@ def _open_config_file(
|
|
|
43
43
|
"""
|
|
44
44
|
match config_file:
|
|
45
45
|
case None:
|
|
46
|
-
path = pathlib.Path("mkdocs.yml")
|
|
46
|
+
path: pathlib.Path | None = pathlib.Path("mkdocs.yml")
|
|
47
47
|
case str() | os.PathLike():
|
|
48
48
|
path = pathlib.Path(config_file)
|
|
49
49
|
case _ if getattr(config_file, "closed", False):
|
|
@@ -123,7 +123,7 @@ class MkNodesConfig(defaults.MkDocsConfig):
|
|
|
123
123
|
config_file_path: str | None = None,
|
|
124
124
|
) -> Self:
|
|
125
125
|
# cfg = yamling.load_yaml_file(file, resolve_inherit=True)
|
|
126
|
-
config_str = upath.UPath(file).read_text()
|
|
126
|
+
config_str = upath.UPath(file).read_text("utf-8")
|
|
127
127
|
str_io = io.StringIO(config_str)
|
|
128
128
|
return cls.from_yaml(str_io, config_file_path=config_file_path)
|
|
129
129
|
|
|
@@ -272,12 +272,12 @@ class MkNodesConfig(defaults.MkDocsConfig):
|
|
|
272
272
|
def update_from_context(self, context: contexts.ProjectContext):
|
|
273
273
|
if not super().extra.get("social"):
|
|
274
274
|
super().extra["social"] = context.metadata.social_info
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
275
|
+
self.repo_url = context.metadata.repository_url
|
|
276
|
+
self.site_description = context.metadata.summary
|
|
277
|
+
self.site_name = context.metadata.distribution_name
|
|
278
|
+
self.site_author = context.metadata.author_name
|
|
279
279
|
text = f"Copyright © {datetime.now().year} {context.metadata.author_name}"
|
|
280
|
-
|
|
280
|
+
self.copyright = text
|
|
281
281
|
|
|
282
282
|
def get_markdown_instance(
|
|
283
283
|
self,
|
|
@@ -1,10 +1,13 @@
|
|
|
1
|
+
#:tombi schema.strict = false
|
|
2
|
+
|
|
1
3
|
[project]
|
|
2
4
|
name = "mkdocs-mknodes"
|
|
3
|
-
version = "0.
|
|
5
|
+
version = "1.0.2"
|
|
4
6
|
description = "Don't write docs. Code them."
|
|
5
7
|
readme = "README.md"
|
|
6
8
|
requires-python = ">=3.13"
|
|
7
9
|
license = "MIT"
|
|
10
|
+
license-files = ["LICENSE"]
|
|
8
11
|
authors = [
|
|
9
12
|
{ name = "Philipp Temminghoff", email = "philipptemminghoff@gmail.com" },
|
|
10
13
|
]
|
|
@@ -38,7 +41,7 @@ dependencies = [
|
|
|
38
41
|
"jinjarope",
|
|
39
42
|
"logfire",
|
|
40
43
|
"mkdocs >=1.5",
|
|
41
|
-
"mknodes",
|
|
44
|
+
"mknodes >= 2.0.0",
|
|
42
45
|
"opentelemetry-instrumentation-jinja2",
|
|
43
46
|
# "opentelemetry-instrumentation-sqlite3",
|
|
44
47
|
"opentelemetry-instrumentation-urllib",
|
|
@@ -60,7 +63,7 @@ Gitter = "https://app.gitter.im/#/room/#mknodes:gitter.im"
|
|
|
60
63
|
Source = "https://github.com/phil65/mkdocs_mknodes"
|
|
61
64
|
|
|
62
65
|
[project.scripts]
|
|
63
|
-
mknodes = "mkdocs_mknodes.cli:cli"
|
|
66
|
+
mkdocs-mknodes = "mkdocs_mknodes.cli:cli"
|
|
64
67
|
|
|
65
68
|
[project.entry-points."mkdocs.plugins"]
|
|
66
69
|
mknodes = "mkdocs_mknodes.plugin:MkNodesPlugin"
|
|
@@ -87,10 +90,9 @@ docs = [
|
|
|
87
90
|
"pymdown-extensions",
|
|
88
91
|
]
|
|
89
92
|
lint = [
|
|
90
|
-
"mypy",
|
|
93
|
+
"mypy; python_version >= '3.14'",
|
|
94
|
+
"mypy[faster-cache]; python_version < '3.14'",
|
|
91
95
|
"ruff",
|
|
92
|
-
# "mypy[faster-cache]; python_version < '3.14'",
|
|
93
|
-
# "mypy; python_version >= '3.14'",
|
|
94
96
|
# Only add below (Copier)
|
|
95
97
|
]
|
|
96
98
|
|
|
@@ -121,7 +123,7 @@ docstring-style = "google"
|
|
|
121
123
|
|
|
122
124
|
[tool.mypy]
|
|
123
125
|
python_version = "3.13"
|
|
124
|
-
disable_error_code = ["assignment", "
|
|
126
|
+
disable_error_code = ["assignment", "import"]
|
|
125
127
|
pretty = true
|
|
126
128
|
plugins = ["pydantic.mypy"]
|
|
127
129
|
|
|
@@ -153,7 +155,8 @@ log_date_format = "%Y-%m-%d %H:%M:%S"
|
|
|
153
155
|
# log_cli_level = "DEBUG"
|
|
154
156
|
log_format = "%(asctime)s %(levelname)s %(message)s"
|
|
155
157
|
minversion = "9.0"
|
|
156
|
-
testpaths = ["tests"]
|
|
158
|
+
testpaths = ["tests/"]
|
|
159
|
+
asyncio_mode = "auto"
|
|
157
160
|
|
|
158
161
|
[tool.ruff]
|
|
159
162
|
line-length = 100
|
|
@@ -161,6 +164,7 @@ extend-exclude = ["docs"]
|
|
|
161
164
|
target-version = "py313"
|
|
162
165
|
|
|
163
166
|
[tool.ruff.lint]
|
|
167
|
+
future-annotations = true
|
|
164
168
|
select = [
|
|
165
169
|
"A", # Flake8-builtins
|
|
166
170
|
# "ANN", # Flake8-Annotations
|
|
@@ -248,6 +252,8 @@ ignore = [
|
|
|
248
252
|
"D408", # Section underline should be in the line following the section's name ("{name}")
|
|
249
253
|
"D409", # Section underline should match the length of its name ("{name}")
|
|
250
254
|
"D413", # Missing blank line after last section ("{name}")
|
|
255
|
+
"EM101", # Exception must not use a string literal, assign to variable first
|
|
256
|
+
"EM102", # Exception must not use an f-string literal, assign to variable first
|
|
251
257
|
"ISC001",
|
|
252
258
|
"PLC0415",
|
|
253
259
|
"PLR0912", # Too many branches
|
|
@@ -261,6 +267,21 @@ ignore = [
|
|
|
261
267
|
[tool.ruff.lint.flake8-quotes]
|
|
262
268
|
docstring-quotes = "double"
|
|
263
269
|
|
|
270
|
+
[tool.ruff.lint.flake8-type-checking]
|
|
271
|
+
runtime-evaluated-base-classes = [
|
|
272
|
+
"pydantic.BaseModel",
|
|
273
|
+
"sqlalchemy.orm.DeclarativeBase",
|
|
274
|
+
"schemez.Schema",
|
|
275
|
+
"sqlmodel.SQLModel",
|
|
276
|
+
]
|
|
277
|
+
runtime-evaluated-decorators = [
|
|
278
|
+
"pydantic.validate_call",
|
|
279
|
+
"fastapi.FastAPI.get",
|
|
280
|
+
"fastapi.FastAPI.post",
|
|
281
|
+
"fastmcp.FastMCP.tool",
|
|
282
|
+
"typer.Typer.command",
|
|
283
|
+
]
|
|
284
|
+
|
|
264
285
|
[tool.ruff.lint.isort]
|
|
265
286
|
lines-after-imports = 2
|
|
266
287
|
# lines-between-types = 1
|
|
@@ -270,11 +291,16 @@ combine-as-imports = true
|
|
|
270
291
|
|
|
271
292
|
[tool.ruff.lint.per-file-ignores]
|
|
272
293
|
"__init__.py" = ["E402", "I001"]
|
|
294
|
+
"scripts/*" = ["INP001"]
|
|
295
|
+
"*tests/*" = ["D100"]
|
|
273
296
|
|
|
274
297
|
[tool.ruff.format]
|
|
275
|
-
# Enable preview style formatting.
|
|
276
298
|
preview = true
|
|
277
299
|
|
|
300
|
+
[tool.ty.environment]
|
|
301
|
+
python-version = "3.13"
|
|
302
|
+
python-platform = "all"
|
|
303
|
+
|
|
278
304
|
[tool.uv]
|
|
279
305
|
default-groups = ["dev", "lint", "docs"]
|
|
280
306
|
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|