mkdocs-mknodes 0.4.1__tar.gz → 0.4.3__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.4.1 → mkdocs_mknodes-0.4.3}/PKG-INFO +1 -1
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/__init__.py +1 -1
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/buildcollector.py +2 -1
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/manual/root.py +1 -1
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/project.py +0 -15
- mkdocs_mknodes-0.4.3/tests/conftest.py +10 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/tests/test_build.py +4 -4
- mkdocs_mknodes-0.4.1/tests/conftest.py +0 -17
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/.editorconfig +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/.github/README.md +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/.github/workflows/build.yml +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/.github/workflows/documentation.yml +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/.gitignore +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/.pre-commit-config.yaml +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/LICENSE +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/README.md +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/configs/mkdocs_mkdocs.yml +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/configs/mkdocs_mkdocstrings.yml +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/configs/mkdocs_shared.yml +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/docs/assets/cli.gif +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/docs/build_process.jinja +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/docs/cli_index.jinja +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/docs/github_index.jinja +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/docs/index.jinja +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/docs/plugin_configuration.jinja +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/docs/use_case_by_config.jinja +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/docs/use_case_default_website.jinja +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/docs/use_cases_index.jinja +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/docs/why_should_i_use_mknodes.jinja +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/duties.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs.yml +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/backends/__init__.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/backends/buildbackend.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/backends/markdownbackend.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/backends/mkdocsbackend.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/buildcontext.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/cli/__init__.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/cli/richstate.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/commands/__init__.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/commands/build_page.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/commands/serve.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/manual/__init__.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/manual/cli_section.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/manual/get_started_section.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/manual/github_index.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/manual/use_cases_section.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/mkdefaultwebsite.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/mkdocsconfig.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/mknodesconfig.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/paths.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/plugin/__init__.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/plugin/mkdocsbuilder.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/plugin/pluginconfig.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/py.typed +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes.sublime-project +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/overrides/_dummy.txt +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/overrides/partials/actions.html +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/pyproject.toml +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/tests/__init__.py +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/tests/data/objects.inv +0 -0
- {mkdocs_mknodes-0.4.1 → mkdocs_mknodes-0.4.3}/tests/test_cli.py +0 -0
|
@@ -5,6 +5,7 @@ from __future__ import annotations
|
|
|
5
5
|
import collections
|
|
6
6
|
import itertools
|
|
7
7
|
import pathlib
|
|
8
|
+
import pprint
|
|
8
9
|
|
|
9
10
|
from typing import TYPE_CHECKING
|
|
10
11
|
|
|
@@ -38,7 +39,7 @@ def add_page_info(page: mk.MkPage, req: resources.Resources):
|
|
|
38
39
|
details = mk.MkAdmonition(code, title=title, collapsible=True, typ="quote")
|
|
39
40
|
adm += details
|
|
40
41
|
|
|
41
|
-
pretty = mk.
|
|
42
|
+
pretty = mk.MkCode(pprint.pformat(req))
|
|
42
43
|
details = mk.MkAdmonition(pretty, title="Resources", collapsible=True, typ="quote")
|
|
43
44
|
adm += details
|
|
44
45
|
|
|
@@ -2,19 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
from __future__ import annotations
|
|
4
4
|
|
|
5
|
-
from collections.abc import Callable
|
|
6
5
|
import os
|
|
7
6
|
|
|
8
7
|
from typing import Generic, TypeVar
|
|
9
8
|
|
|
10
|
-
from mknodes import paths
|
|
11
9
|
from mknodes.info import contexts, folderinfo, linkprovider, reporegistry
|
|
12
10
|
from mknodes.navs import mknav
|
|
13
11
|
from mknodes.theme import theme as theme_
|
|
14
|
-
from mknodes.utils import classhelpers, log, reprhelpers
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
logger = log.get_logger(__name__)
|
|
18
12
|
|
|
19
13
|
|
|
20
14
|
T = TypeVar("T", bound=theme_.Theme)
|
|
@@ -27,29 +21,24 @@ class Project(Generic[T]):
|
|
|
27
21
|
self,
|
|
28
22
|
theme: T,
|
|
29
23
|
repo: str | os.PathLike | None | folderinfo.FolderInfo = None,
|
|
30
|
-
build_fn: str | Callable = paths.DEFAULT_BUILD_FN,
|
|
31
24
|
base_url: str = "",
|
|
32
25
|
use_directory_urls: bool = True,
|
|
33
26
|
clone_depth: int = 100,
|
|
34
|
-
jinja_extensions: list[str] | None = None,
|
|
35
27
|
):
|
|
36
28
|
"""The main project to create a website.
|
|
37
29
|
|
|
38
30
|
Arguments:
|
|
39
31
|
theme: The theme to use
|
|
40
32
|
repo: Path to the git repository
|
|
41
|
-
build_fn: Callable to create the website with
|
|
42
33
|
base_url: Base url of the website
|
|
43
34
|
use_directory_urls: Whether urls are in directory-style
|
|
44
35
|
clone_depth: Amount of commits to clone in case repository is remote.
|
|
45
|
-
jinja_extensions: Optional additional jinja extensions to load.
|
|
46
36
|
"""
|
|
47
37
|
self.linkprovider = linkprovider.LinkProvider(
|
|
48
38
|
base_url=base_url,
|
|
49
39
|
use_directory_urls=use_directory_urls,
|
|
50
40
|
include_stdlib=True,
|
|
51
41
|
)
|
|
52
|
-
self.build_fn = classhelpers.to_callable(build_fn)
|
|
53
42
|
self.theme: T = theme
|
|
54
43
|
git_repo = reporegistry.get_repo(str(repo or "."), clone_depth=clone_depth)
|
|
55
44
|
self.folderinfo = folderinfo.FolderInfo(git_repo.working_dir)
|
|
@@ -63,9 +52,6 @@ class Project(Generic[T]):
|
|
|
63
52
|
)
|
|
64
53
|
self._root = mknav.MkNav(context=self.context)
|
|
65
54
|
|
|
66
|
-
def __repr__(self):
|
|
67
|
-
return reprhelpers.get_repr(self, repo_path=str(self.folderinfo.path))
|
|
68
|
-
|
|
69
55
|
@property
|
|
70
56
|
def root(self) -> mknav.MkNav:
|
|
71
57
|
return self._root
|
|
@@ -81,4 +67,3 @@ if __name__ == "__main__":
|
|
|
81
67
|
|
|
82
68
|
theme = mk.MaterialTheme()
|
|
83
69
|
project = Project(theme=theme)
|
|
84
|
-
log.basic()
|
|
@@ -13,10 +13,10 @@ _dir = tempfile.TemporaryDirectory(prefix="mknodes_")
|
|
|
13
13
|
build_folder = pathlib.Path(_dir.name)
|
|
14
14
|
|
|
15
15
|
|
|
16
|
-
def test_build(
|
|
17
|
-
|
|
16
|
+
def test_build():
|
|
17
|
+
nav = mk.MkNav.with_context("Test")
|
|
18
18
|
cfg = mkdocsconfig.Config()
|
|
19
|
-
cfg.update_from_context(
|
|
19
|
+
cfg.update_from_context(nav.ctx)
|
|
20
20
|
mkdocs_backend = mkdocsbackend.MkDocsBackend(
|
|
21
21
|
config=cfg,
|
|
22
22
|
directory=build_folder,
|
|
@@ -30,7 +30,7 @@ def test_build(mkdocs_mknodes_project):
|
|
|
30
30
|
backends=[mkdocs_backend, markdown_backend],
|
|
31
31
|
show_page_info=True,
|
|
32
32
|
)
|
|
33
|
-
build_info = collector.collect(
|
|
33
|
+
build_info = collector.collect(nav, mk.MaterialTheme())
|
|
34
34
|
assert build_info
|
|
35
35
|
|
|
36
36
|
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
from __future__ import annotations
|
|
2
|
-
|
|
3
|
-
import mknodes as mk
|
|
4
|
-
import pytest
|
|
5
|
-
|
|
6
|
-
from mkdocs_mknodes import mkdocsconfig, project
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
@pytest.fixture(scope="session")
|
|
10
|
-
def config():
|
|
11
|
-
return mkdocsconfig.Config()
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
@pytest.fixture(scope="session")
|
|
15
|
-
def mkdocs_mknodes_project():
|
|
16
|
-
skin = mk.MaterialTheme()
|
|
17
|
-
return project.Project(skin, build_fn="mkdocs_mknodes.manual.root:build")
|
|
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
|
|
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
|