mkdocs-mknodes 0.3.4__tar.gz → 0.3.5__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.3.4 → mkdocs_mknodes-0.3.5}/.github/README.md +1 -1
  2. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/PKG-INFO +4 -3
  3. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/README.md +1 -1
  4. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs.yml +1 -1
  5. mkdocs_mknodes-0.3.5/mkdocs_mknodes/__init__.py +1 -0
  6. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/cli/__init__.py +4 -4
  7. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/manual/github_index.py +1 -1
  8. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/mkdocsconfig.py +2 -2
  9. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/plugin/pluginconfig.py +3 -2
  10. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/resources/github_index.jinja +1 -1
  11. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/resources/use_case_by_config.jinja +1 -1
  12. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/resources/use_case_default_website.jinja +1 -1
  13. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/pyproject.toml +2 -1
  14. mkdocs_mknodes-0.3.4/mkdocs_mknodes/__init__.py +0 -1
  15. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/.editorconfig +0 -0
  16. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/.github/workflows/build.yml +0 -0
  17. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/.github/workflows/documentation.yml +0 -0
  18. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/.gitignore +0 -0
  19. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/.pre-commit-config.yaml +0 -0
  20. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/LICENSE +0 -0
  21. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/configs/mkdocs_mkdocs.yml +0 -0
  22. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/configs/mkdocs_mkdocstrings.yml +0 -0
  23. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/configs/mkdocs_multipage.yml +0 -0
  24. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/configs/mkdocs_shared.yml +0 -0
  25. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/docs/assets/cli.gif +0 -0
  26. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/duties.py +0 -0
  27. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/backends/__init__.py +0 -0
  28. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/backends/buildbackend.py +0 -0
  29. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/backends/markdownbackend.py +0 -0
  30. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/backends/mkdocsbackend.py +0 -0
  31. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/buildcollector.py +0 -0
  32. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/buildcontext.py +0 -0
  33. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/cli/richstate.py +0 -0
  34. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/commands/__init__.py +0 -0
  35. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/commands/build_page.py +0 -0
  36. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/commands/serve.py +0 -0
  37. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/manual/__init__.py +0 -0
  38. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/manual/cli_section.py +0 -0
  39. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/manual/get_started_section.py +0 -0
  40. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/manual/multi_project.py +0 -0
  41. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/manual/root.py +0 -0
  42. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/manual/use_cases_section.py +0 -0
  43. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/paths.py +0 -0
  44. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/plugin/__init__.py +0 -0
  45. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/plugin/mkdocsbuilder.py +0 -0
  46. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
  47. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
  48. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/py.typed +0 -0
  49. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/resources/build_process.jinja +0 -0
  50. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/resources/cli_index.jinja +0 -0
  51. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/resources/index.jinja +0 -0
  52. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
  53. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/resources/plugin_configuration.jinja +0 -0
  54. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
  55. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/resources/use_case_subwebsites.jinja +0 -0
  56. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/resources/use_cases_index.jinja +0 -0
  57. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes/resources/why_should_i_use_mknodes.jinja +0 -0
  58. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/mkdocs_mknodes.sublime-project +0 -0
  59. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/overrides/_dummy.txt +0 -0
  60. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/overrides/partials/actions.html +0 -0
  61. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/tests/__init__.py +0 -0
  62. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/tests/conftest.py +0 -0
  63. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/tests/data/objects.inv +0 -0
  64. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/tests/test_build.py +0 -0
  65. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.5}/tests/test_cli.py +0 -0
@@ -45,7 +45,7 @@ def create_github_index_md() -> mk.MkPage:
45
45
  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
46
46
  [![PyUp](https://pyup.io/repos/github/phil65/mkdocs_mknodes/shield.svg)](https://pyup.io/repos/github/phil65/mkdocs_mknodes/)
47
47
 
48
- [Read the completely coded documentation!](https://phil65.github.io/mkdocs_mknodes/)
48
+ [Read the completely coded documentation!](https://phil65.github.io/mkdocs-mknodes/)
49
49
 
50
50
  ## How to install
51
51
 
@@ -1,8 +1,8 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: mkdocs-mknodes
3
- Version: 0.3.4
3
+ Version: 0.3.5
4
4
  Summary: Don't write docs. Code them.
5
- Project-URL: Documentation, https://phil65.github.io/mkdocs_mknodes/
5
+ Project-URL: Documentation, https://phil65.github.io/mkdocs-mknodes/
6
6
  Project-URL: Source, https://github.com/phil65/mkdocs_mknodes
7
7
  Project-URL: Gitter, https://app.gitter.im/#/room/#mknodes:gitter.im
8
8
  Author-email: Philipp Temminghoff <philipptemminghoff@gmail.com>
@@ -25,6 +25,7 @@ Classifier: Topic :: Software Development :: User Interfaces
25
25
  Classifier: Topic :: Text Processing :: Markup :: Markdown
26
26
  Requires-Python: >=3.11
27
27
  Requires-Dist: jinja2
28
+ Requires-Dist: jinjarope
28
29
  Requires-Dist: mkdocs>=1.5
29
30
  Requires-Dist: mknodes
30
31
  Requires-Dist: rich
@@ -79,7 +80,7 @@ def create_github_index_md() -> mk.MkPage:
79
80
  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
80
81
  [![PyUp](https://pyup.io/repos/github/phil65/mkdocs_mknodes/shield.svg)](https://pyup.io/repos/github/phil65/mkdocs_mknodes/)
81
82
 
82
- [Read the completely coded documentation!](https://phil65.github.io/mkdocs_mknodes/)
83
+ [Read the completely coded documentation!](https://phil65.github.io/mkdocs-mknodes/)
83
84
 
84
85
  ## How to install
85
86
 
@@ -45,7 +45,7 @@ def create_github_index_md() -> mk.MkPage:
45
45
  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
46
46
  [![PyUp](https://pyup.io/repos/github/phil65/mkdocs_mknodes/shield.svg)](https://pyup.io/repos/github/phil65/mkdocs_mknodes/)
47
47
 
48
- [Read the completely coded documentation!](https://phil65.github.io/mkdocs_mknodes/)
48
+ [Read the completely coded documentation!](https://phil65.github.io/mkdocs-mknodes/)
49
49
 
50
50
  ## How to install
51
51
 
@@ -1,7 +1,7 @@
1
1
  site_name: MkNodes (MkDocs plugin)
2
2
  site_description: "Don´t write docs. Code them."
3
3
  repo_url: "https://github.com/phil65/mkdocs_mknodes/"
4
- site_url: https://phil65.github.io/mkdocs_mknodes/
4
+ site_url: https://phil65.github.io/mkdocs-mknodes/
5
5
  site_author: Philipp Temminghoff
6
6
  copyright: Copyright &copy; 2023 Philipp Temminghoff
7
7
 
@@ -0,0 +1 @@
1
+ __version__ = "0.3.5"
@@ -22,7 +22,7 @@ cli = t.Typer(
22
22
  name="MkNodes",
23
23
  help=(
24
24
  " 🚀🚀🚀 MkNodes CLI interface. Build websites from command line! 🚀🚀🚀\n\n"
25
- "Check out https://phil65.github.io/mkdocs_mknodes/ !"
25
+ "Check out https://phil65.github.io/mkdocs-mknodes/ !"
26
26
  ),
27
27
  no_args_is_help=True,
28
28
  )
@@ -85,7 +85,7 @@ def build(
85
85
  Runs the build script on given repository (either locally or a hosted one), adapts
86
86
  the config file automatically and creates the HTML website in given site dir.
87
87
 
88
- Further info here: https://phil65.github.io/mkdocs_mknodes/CLI/
88
+ Further info here: https://phil65.github.io/mkdocs-mknodes/CLI/
89
89
  """
90
90
  build_page.build(
91
91
  config_path=config_path,
@@ -116,7 +116,7 @@ def serve(
116
116
  Runs the build script on given repository (either locally or a hosted one), adapts
117
117
  the config file automatically and serves a webpage on http://127.0.0.1/8000/.
118
118
 
119
- Further info here: https://phil65.github.io/mkdocs_mknodes/CLI/
119
+ Further info here: https://phil65.github.io/mkdocs-mknodes/CLI/
120
120
  """
121
121
  serve_.serve(
122
122
  config_path=config_path,
@@ -145,7 +145,7 @@ def create_config(
145
145
  infers the required resources (CSS / JS / Md extensions) as well as metadata
146
146
  and creates a MkDocs config file.
147
147
 
148
- Further info here: https://phil65.github.io/mkdocs_mknodes/CLI/
148
+ Further info here: https://phil65.github.io/mkdocs-mknodes/CLI/
149
149
  """
150
150
  build_fn = build_fn or paths.DEFAULT_BUILD_FN
151
151
 
@@ -1,7 +1,7 @@
1
1
  import mknodes as mk
2
2
 
3
3
 
4
- DOC_URL = "https://phil65.github.io/mkdocs_mknodes/"
4
+ DOC_URL = "https://phil65.github.io/mkdocs-mknodes/"
5
5
 
6
6
 
7
7
  def create_github_index_md() -> mk.MkPage:
@@ -13,12 +13,12 @@ from typing import IO, Any
13
13
  from urllib import parse
14
14
 
15
15
  import jinja2
16
+ import jinjarope
16
17
 
17
18
  from mkdocs.commands import get_deps
18
19
  from mkdocs.config.defaults import MkDocsConfig
19
20
  from mkdocs.plugins import get_plugin_logger
20
21
  from mknodes.info import contexts
21
- from mknodes.jinja import loaders
22
22
  from mknodes.mdlib import mdconverter
23
23
  from mknodes.utils import pathhelpers, reprhelpers
24
24
 
@@ -218,7 +218,7 @@ class Config:
218
218
 
219
219
  def get_jinja_config(self) -> Sequence[jinja2.BaseLoader]:
220
220
  cfg = self.plugin.config.get_jinja_config()
221
- cfg["loader"] |= loaders.FileSystemLoader(self.docs_dir)
221
+ cfg["loader"] |= jinjarope.FileSystemLoader(self.docs_dir)
222
222
  return cfg
223
223
 
224
224
  def get_install_candidates(self) -> list[str]:
@@ -6,9 +6,10 @@ from collections.abc import Callable, Sequence
6
6
  import functools
7
7
 
8
8
  import jinja2
9
+ import jinjarope
9
10
 
11
+ from jinjarope import loaders
10
12
  from mkdocs.config import base, config_options as c
11
- from mknodes.jinja import loaders
12
13
  from mknodes.utils import classhelpers
13
14
 
14
15
 
@@ -129,7 +130,7 @@ class PluginConfig(base.Config):
129
130
  variable_start_string=self.jinja_variable_start_string,
130
131
  variable_end_string=self.jinja_variable_end_string,
131
132
  undefined=self.jinja_on_undefined,
132
- loader=loaders.ChoiceLoader(self.get_loaders()),
133
+ loader=jinjarope.ChoiceLoader(self.get_loaders()),
133
134
  )
134
135
 
135
136
  def get_loaders(self) -> Sequence[jinja2.BaseLoader]:
@@ -4,7 +4,7 @@
4
4
 
5
5
  {{ ["version", "status"] | MkShields }}
6
6
 
7
- {{ "https://phil65.github.io/mkdocs_mknodes/" | MkLink("Read the completely coded documentation!")}}
7
+ {{ "https://phil65.github.io/mkdocs-mknodes/" | MkLink("Read the completely coded documentation!")}}
8
8
 
9
9
  {{ "mkdocs_mknodes" | MkInstallGuide }}
10
10
 
@@ -14,6 +14,6 @@ Combined with this CLI call...
14
14
  Will create this website:
15
15
 
16
16
 
17
- {{ "https://phil65.github.io/mkdocs_mknodes/mkdocstrings" | MkLink(as_button=True, icon="web") }}
17
+ {{ "https://phil65.github.io/mkdocs-mknodes/mkdocstrings" | MkLink(as_button=True, icon="web") }}
18
18
 
19
19
 
@@ -16,6 +16,6 @@ Combined with this CLI call...
16
16
  Will create this website:
17
17
 
18
18
 
19
- {{ "https://phil65.github.io/mkdocs_mknodes/mkdocs" | MkLink(as_button=True, icon="web") }}
19
+ {{ "https://phil65.github.io/mkdocs-mknodes/mkdocs" | MkLink(as_button=True, icon="web") }}
20
20
 
21
21
 
@@ -110,6 +110,7 @@ dependencies = [
110
110
 
111
111
  # Tools
112
112
  "jinja2",
113
+ "jinjarope",
113
114
  "universal_pathlib",
114
115
  ]
115
116
  license = "MIT"
@@ -121,7 +122,7 @@ mknodes = "mkdocs_mknodes.cli:cli"
121
122
  mknodes = "mkdocs_mknodes.plugin:MkNodesPlugin"
122
123
 
123
124
  [project.urls]
124
- Documentation = "https://phil65.github.io/mkdocs_mknodes/"
125
+ Documentation = "https://phil65.github.io/mkdocs-mknodes/"
125
126
  Source = "https://github.com/phil65/mkdocs_mknodes"
126
127
  Gitter = "https://app.gitter.im/#/room/#mknodes:gitter.im"
127
128
 
@@ -1 +0,0 @@
1
- __version__ = "0.3.4"
File without changes
File without changes