mkdocs-mknodes 0.4.2__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.
Files changed (65) hide show
  1. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/PKG-INFO +1 -1
  2. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/__init__.py +1 -1
  3. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/project.py +0 -15
  4. mkdocs_mknodes-0.4.3/tests/conftest.py +10 -0
  5. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/tests/test_build.py +4 -4
  6. mkdocs_mknodes-0.4.2/tests/conftest.py +0 -17
  7. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/.editorconfig +0 -0
  8. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/.github/README.md +0 -0
  9. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/.github/workflows/build.yml +0 -0
  10. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/.github/workflows/documentation.yml +0 -0
  11. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/.gitignore +0 -0
  12. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/.pre-commit-config.yaml +0 -0
  13. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/LICENSE +0 -0
  14. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/README.md +0 -0
  15. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/configs/mkdocs_mkdocs.yml +0 -0
  16. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/configs/mkdocs_mkdocstrings.yml +0 -0
  17. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/configs/mkdocs_shared.yml +0 -0
  18. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/docs/assets/cli.gif +0 -0
  19. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/docs/build_process.jinja +0 -0
  20. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/docs/cli_index.jinja +0 -0
  21. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/docs/github_index.jinja +0 -0
  22. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/docs/index.jinja +0 -0
  23. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/docs/plugin_configuration.jinja +0 -0
  24. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/docs/use_case_by_config.jinja +0 -0
  25. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/docs/use_case_default_website.jinja +0 -0
  26. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/docs/use_cases_index.jinja +0 -0
  27. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/docs/why_should_i_use_mknodes.jinja +0 -0
  28. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/duties.py +0 -0
  29. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs.yml +0 -0
  30. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/backends/__init__.py +0 -0
  31. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/backends/buildbackend.py +0 -0
  32. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/backends/markdownbackend.py +0 -0
  33. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/backends/mkdocsbackend.py +0 -0
  34. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/buildcollector.py +0 -0
  35. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/buildcontext.py +0 -0
  36. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/cli/__init__.py +0 -0
  37. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/cli/richstate.py +0 -0
  38. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/commands/__init__.py +0 -0
  39. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/commands/build_page.py +0 -0
  40. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/commands/serve.py +0 -0
  41. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/manual/__init__.py +0 -0
  42. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/manual/cli_section.py +0 -0
  43. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/manual/get_started_section.py +0 -0
  44. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/manual/github_index.py +0 -0
  45. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/manual/root.py +0 -0
  46. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/manual/use_cases_section.py +0 -0
  47. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/mkdefaultwebsite.py +0 -0
  48. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/mkdocsconfig.py +0 -0
  49. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/mknodesconfig.py +0 -0
  50. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/paths.py +0 -0
  51. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/plugin/__init__.py +0 -0
  52. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/plugin/mkdocsbuilder.py +0 -0
  53. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
  54. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/plugin/pluginconfig.py +0 -0
  55. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
  56. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/py.typed +0 -0
  57. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
  58. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
  59. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/mkdocs_mknodes.sublime-project +0 -0
  60. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/overrides/_dummy.txt +0 -0
  61. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/overrides/partials/actions.html +0 -0
  62. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/pyproject.toml +0 -0
  63. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/tests/__init__.py +0 -0
  64. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/tests/data/objects.inv +0 -0
  65. {mkdocs_mknodes-0.4.2 → mkdocs_mknodes-0.4.3}/tests/test_cli.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: mkdocs-mknodes
3
- Version: 0.4.2
3
+ Version: 0.4.3
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
@@ -1,4 +1,4 @@
1
- __version__ = "0.4.2"
1
+ __version__ = "0.4.3"
2
2
 
3
3
 
4
4
  from .mkdefaultwebsite import MkDefaultWebsite
@@ -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()
@@ -0,0 +1,10 @@
1
+ from __future__ import annotations
2
+
3
+ import pytest
4
+
5
+ from mkdocs_mknodes import mkdocsconfig
6
+
7
+
8
+ @pytest.fixture(scope="session")
9
+ def config():
10
+ return mkdocsconfig.Config()
@@ -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(mkdocs_mknodes_project):
17
- project = mkdocs_mknodes_project
16
+ def test_build():
17
+ nav = mk.MkNav.with_context("Test")
18
18
  cfg = mkdocsconfig.Config()
19
- cfg.update_from_context(project.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(project.root, project.theme)
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