mkdocs-mknodes 0.2.11__tar.gz → 0.2.13__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-0.2.11 → mkdocs_mknodes-0.2.13}/PKG-INFO +1 -1
- mkdocs_mknodes-0.2.13/mkdocs_mknodes/__init__.py +1 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/backends/mkdocsbackend.py +0 -1
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/cli/__init__.py +3 -3
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/mkdocsconfig.py +1 -1
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/plugin/__init__.py +3 -12
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/plugin/pluginconfig.py +2 -2
- mkdocs_mknodes-0.2.13/tests/__init__.py +0 -0
- mkdocs_mknodes-0.2.11/mkdocs_mknodes/__init__.py +0 -1
- mkdocs_mknodes-0.2.11/mkdocs_mknodes/commands/create_page.py +0 -30
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/.editorconfig +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/.github/README.md +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/.github/workflows/build.yml +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/.github/workflows/documentation.yml +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/.gitignore +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/.pre-commit-config.yaml +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/LICENSE +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/Makefile +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/README.md +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/configs/mkdocs_mkdocs.yml +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/configs/mkdocs_mkdocstrings.yml +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/configs/mkdocs_multipage.yml +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/configs/mkdocs_shared.yml +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/docs/assets/cli.gif +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs.yml +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/backends/__init__.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/backends/buildbackend.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/backends/markdownbackend.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/buildcollector.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/buildcontext.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/cli/richstate.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/commands/__init__.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/commands/build_page.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/commands/serve.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/manual/__init__.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/manual/cli_section.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/manual/get_started_section.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/manual/github_index.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/manual/multi_project.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/manual/root.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/manual/use_cases_section.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/paths.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/plugin/mkdocsbuilder.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
- /mkdocs_mknodes-0.2.11/tests/__init__.py → /mkdocs_mknodes-0.2.13/mkdocs_mknodes/py.typed +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/build_process.jinja +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/cli_index.jinja +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/github_index.jinja +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/index.jinja +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/plugin_configuration.jinja +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/use_case_by_config.jinja +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/use_case_default_website.jinja +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/use_case_subwebsites.jinja +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/use_cases_index.jinja +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/why_should_i_use_mknodes.jinja +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes.sublime-project +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/overrides/_dummy.txt +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/overrides/partials/actions.html +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/pyproject.toml +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/tests/conftest.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/tests/data/objects.inv +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/tests/test_build.py +0 -0
- {mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/tests/test_cli.py +0 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.2.13"
|
|
@@ -7,7 +7,7 @@ import logging
|
|
|
7
7
|
from mknodes.info.mkdocsconfigfile import MkDocsConfigFile
|
|
8
8
|
import typer as t
|
|
9
9
|
|
|
10
|
-
from mknodes.utils import log, yamlhelpers
|
|
10
|
+
from mknodes.utils import classhelpers, log, yamlhelpers
|
|
11
11
|
|
|
12
12
|
from mkdocs_mknodes import buildcollector, paths
|
|
13
13
|
from mkdocs_mknodes.cli import richstate
|
|
@@ -167,8 +167,8 @@ def create_config(
|
|
|
167
167
|
build_fn=build_fn,
|
|
168
168
|
clone_depth=1,
|
|
169
169
|
)
|
|
170
|
-
|
|
171
|
-
proj
|
|
170
|
+
builder = classhelpers.to_callable(build_fn)
|
|
171
|
+
builder(project=proj)
|
|
172
172
|
collector = buildcollector.BuildCollector([])
|
|
173
173
|
assert proj._root
|
|
174
174
|
info = collector.collect(proj._root, skin)
|
|
@@ -135,7 +135,7 @@ class Config:
|
|
|
135
135
|
jinja_loaders: list[jinja2.BaseLoader] = [loaders.FileSystemLoader(self.docs_dir)]
|
|
136
136
|
for loader_dct in self.mknodes_config.get("jinja_loaders", []):
|
|
137
137
|
dct = loader_dct.copy()
|
|
138
|
-
kls = loaders.LOADERS[dct.pop("
|
|
138
|
+
kls = loaders.LOADERS[dct.pop("type")]
|
|
139
139
|
loader = kls(**dct)
|
|
140
140
|
jinja_loaders.append(loader)
|
|
141
141
|
return jinja_loaders
|
|
@@ -49,7 +49,6 @@ class Build:
|
|
|
49
49
|
base_url,
|
|
50
50
|
use_directory_urls: bool = True,
|
|
51
51
|
clone_depth: int = 100,
|
|
52
|
-
**kwargs,
|
|
53
52
|
):
|
|
54
53
|
if not build_fn:
|
|
55
54
|
return
|
|
@@ -59,14 +58,10 @@ class Build:
|
|
|
59
58
|
theme=theme,
|
|
60
59
|
repo=repo_path,
|
|
61
60
|
build_fn=build_fn,
|
|
62
|
-
build_kwargs=kwargs,
|
|
63
61
|
clone_depth=clone_depth,
|
|
64
62
|
)
|
|
65
63
|
|
|
66
|
-
def
|
|
67
|
-
logger.info("Generating pages...")
|
|
68
|
-
self.project.build()
|
|
69
|
-
|
|
64
|
+
def collect_build_data(self, backends, show_page_info, render_all_pages):
|
|
70
65
|
logger.info("Setting up build backends...")
|
|
71
66
|
collector = buildcollector.BuildCollector(
|
|
72
67
|
backends=backends,
|
|
@@ -106,8 +101,7 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
|
|
|
106
101
|
use_directory_urls=config.use_directory_urls,
|
|
107
102
|
theme=skin,
|
|
108
103
|
repo=self.config.repo_path,
|
|
109
|
-
build_fn=self.config.
|
|
110
|
-
build_kwargs=self.config.kwargs,
|
|
104
|
+
build_fn=self.config.get_builder(),
|
|
111
105
|
clone_depth=self.config.clone_depth,
|
|
112
106
|
)
|
|
113
107
|
|
|
@@ -143,7 +137,6 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
|
|
|
143
137
|
|
|
144
138
|
logger.info("Updating MkDocs config metadata...")
|
|
145
139
|
cfg.update_from_context(self.project.context)
|
|
146
|
-
cfg.extra["status"] = {}
|
|
147
140
|
self.project.theme.adapt_extras(cfg.extra)
|
|
148
141
|
|
|
149
142
|
logger.info("Setting up build backends...")
|
|
@@ -216,9 +209,7 @@ class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
|
|
|
216
209
|
|
|
217
210
|
def on_post_build(self, config: MkDocsConfig):
|
|
218
211
|
"""Delete the temporary template files."""
|
|
219
|
-
if not config.theme.custom_dir:
|
|
220
|
-
return
|
|
221
|
-
if not self.config.build_fn:
|
|
212
|
+
if not config.theme.custom_dir or not self.config.build_fn:
|
|
222
213
|
return
|
|
223
214
|
for template in self.build_info.templates:
|
|
224
215
|
assert template.filename
|
|
@@ -68,12 +68,12 @@ class PluginConfig(base.Config):
|
|
|
68
68
|
jinja_loaders = c.Optional(c.ListOfItems(c.Type(dict)))
|
|
69
69
|
"""List containing additional jinja loaders to use.
|
|
70
70
|
|
|
71
|
-
Dictionaries must have the
|
|
71
|
+
Dictionaries must have the `type` key set to either "filesystem" or "fsspec".
|
|
72
72
|
|
|
73
73
|
Examples:
|
|
74
74
|
``` yaml
|
|
75
75
|
jinja_loaders:
|
|
76
|
-
-
|
|
76
|
+
- type: fsspec
|
|
77
77
|
protocol: github
|
|
78
78
|
repo: mknodes
|
|
79
79
|
org: phil65
|
|
File without changes
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
__version__ = "0.2.11"
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
from __future__ import annotations
|
|
2
|
-
|
|
3
|
-
import mknodes as mk
|
|
4
|
-
|
|
5
|
-
from mknodes import paths
|
|
6
|
-
from mknodes.utils import log
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
logger = log.get_logger(__name__)
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
def build_page(path, repo_path: str = ".", build_fn: str = paths.DEFAULT_BUILD_FN):
|
|
13
|
-
skin = mk.Theme("material")
|
|
14
|
-
proj = mk.Project(
|
|
15
|
-
base_url="",
|
|
16
|
-
use_directory_urls=True,
|
|
17
|
-
theme=skin,
|
|
18
|
-
repo=repo_path,
|
|
19
|
-
build_fn=build_fn,
|
|
20
|
-
clone_depth=1,
|
|
21
|
-
)
|
|
22
|
-
proj.build()
|
|
23
|
-
proj.env.add_template(path)
|
|
24
|
-
node = mk.MkJinjaTemplate(path, context=proj.context)
|
|
25
|
-
return str(node)
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
if __name__ == "__main__":
|
|
29
|
-
text = build_page("mkdocs_mknodes/resources/github_index.jinja")
|
|
30
|
-
print(text)
|
|
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
|
{mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/manual/get_started_section.py
RENAMED
|
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
|
{mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/build_process.jinja
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/plugin_configuration.jinja
RENAMED
|
File without changes
|
|
File without changes
|
{mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/use_case_by_config.jinja
RENAMED
|
File without changes
|
|
File without changes
|
{mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/use_case_subwebsites.jinja
RENAMED
|
File without changes
|
{mkdocs_mknodes-0.2.11 → mkdocs_mknodes-0.2.13}/mkdocs_mknodes/resources/use_cases_index.jinja
RENAMED
|
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
|