mkdocs-mknodes 0.3.4__tar.gz → 0.3.6__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 (66) hide show
  1. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/.github/README.md +1 -1
  2. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/.pre-commit-config.yaml +1 -1
  3. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/PKG-INFO +4 -3
  4. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/README.md +1 -1
  5. mkdocs_mknodes-0.3.6/configs/mkdocs_mkdocstrings.yml +24 -0
  6. {mkdocs_mknodes-0.3.4/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/github_index.jinja +1 -1
  7. {mkdocs_mknodes-0.3.4/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/use_case_by_config.jinja +1 -1
  8. {mkdocs_mknodes-0.3.4/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/use_case_default_website.jinja +1 -1
  9. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/duties.py +15 -13
  10. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs.yml +1 -1
  11. mkdocs_mknodes-0.3.6/mkdocs_mknodes/__init__.py +1 -0
  12. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/buildcollector.py +13 -3
  13. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/cli/__init__.py +4 -4
  14. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/commands/build_page.py +3 -3
  15. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/github_index.py +1 -1
  16. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/root.py +0 -1
  17. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/mkdocsconfig.py +2 -2
  18. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/plugin/pluginconfig.py +3 -2
  19. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/pyproject.toml +6 -1
  20. mkdocs_mknodes-0.3.4/configs/mkdocs_mkdocstrings.yml +0 -24
  21. mkdocs_mknodes-0.3.4/mkdocs_mknodes/__init__.py +0 -1
  22. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/.editorconfig +0 -0
  23. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/.github/workflows/build.yml +0 -0
  24. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/.github/workflows/documentation.yml +0 -0
  25. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/.gitignore +0 -0
  26. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/LICENSE +0 -0
  27. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/configs/mkdocs_mkdocs.yml +0 -0
  28. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/configs/mkdocs_multipage.yml +0 -0
  29. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/configs/mkdocs_shared.yml +0 -0
  30. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/docs/assets/cli.gif +0 -0
  31. {mkdocs_mknodes-0.3.4/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/build_process.jinja +0 -0
  32. {mkdocs_mknodes-0.3.4/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/cli_index.jinja +0 -0
  33. {mkdocs_mknodes-0.3.4/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/index.jinja +0 -0
  34. {mkdocs_mknodes-0.3.4/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/plugin_configuration.jinja +0 -0
  35. {mkdocs_mknodes-0.3.4/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/use_case_subwebsites.jinja +0 -0
  36. {mkdocs_mknodes-0.3.4/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/use_cases_index.jinja +0 -0
  37. {mkdocs_mknodes-0.3.4/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/why_should_i_use_mknodes.jinja +0 -0
  38. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/backends/__init__.py +0 -0
  39. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/backends/buildbackend.py +0 -0
  40. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/backends/markdownbackend.py +0 -0
  41. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/backends/mkdocsbackend.py +0 -0
  42. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/buildcontext.py +0 -0
  43. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/cli/richstate.py +0 -0
  44. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/commands/__init__.py +0 -0
  45. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/commands/serve.py +0 -0
  46. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/__init__.py +0 -0
  47. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/cli_section.py +0 -0
  48. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/get_started_section.py +0 -0
  49. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/multi_project.py +0 -0
  50. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/use_cases_section.py +0 -0
  51. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/paths.py +0 -0
  52. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/plugin/__init__.py +0 -0
  53. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/plugin/mkdocsbuilder.py +0 -0
  54. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
  55. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
  56. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/py.typed +0 -0
  57. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
  58. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
  59. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes.sublime-project +0 -0
  60. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/overrides/_dummy.txt +0 -0
  61. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/overrides/partials/actions.html +0 -0
  62. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/tests/__init__.py +0 -0
  63. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/tests/conftest.py +0 -0
  64. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/tests/data/objects.inv +0 -0
  65. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/tests/test_build.py +0 -0
  66. {mkdocs_mknodes-0.3.4 → mkdocs_mknodes-0.3.6}/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
 
@@ -36,7 +36,7 @@ repos:
36
36
  additional_dependencies: [mkdocs]
37
37
 
38
38
  - repo: https://github.com/charliermarsh/ruff-pre-commit
39
- rev: v0.1.3
39
+ rev: v0.1.4
40
40
  hooks:
41
41
  - id: ruff
42
42
  - id: ruff-format
@@ -1,8 +1,8 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: mkdocs-mknodes
3
- Version: 0.3.4
3
+ Version: 0.3.6
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
 
@@ -0,0 +1,24 @@
1
+ INHERIT: mkdocs_shared.yml
2
+
3
+ site_name: MkDocstrings
4
+ site_description: A MkDocstrings page created by MkNodes
5
+ repo_url: "https://github.com/mkdocstrings/mkdocstrings/"
6
+ site_url: https://phil65.github.io/mknodes/mkdocstrings/
7
+ plugins:
8
+ - mknodes:
9
+ repo_path: https://github.com/mkdocstrings/mkdocstrings.git
10
+ clone_depth: 100
11
+ build_fn: mknodes.navs.mkemptywebsite:MkEmptyWebsite.for_project
12
+ kwargs:
13
+ static_pages:
14
+ Development:
15
+ - Changelog: "{{ mk.MkChangelog() }}"
16
+ - Code of conduct: "{{ mk.MkCodeOfConduct() }}"
17
+ - Commit conventions: "{{ mk.MkCommitConventions() }}"
18
+ - Pull requests: "{{ mk.MkPullRequestGuidelines() }}"
19
+ - Development environment: "{{ mk.MkDevEnvSetup() }}"
20
+ - Tools: "{{ mk.MkDevTools() }}"
21
+ - Dependencies: "{{ mk.MkDependencyTable() }}"
22
+ - Module overview: "{{ mk.MkModuleOverview() }}"
23
+ - Plugin flow: "{{ mk.MkPluginFlow() }}"
24
+ - License: "{{ mk.MkLicense() }}"
@@ -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
 
@@ -12,23 +12,24 @@ UPDATE_CMD = f"""{ENV_PREFIX}python -m pip list {" ".join(PARAMS)}"""
12
12
 
13
13
 
14
14
  @duty(capture=False)
15
- def build(ctx):
15
+ def build(ctx, *args: str):
16
16
  """Build a MkNodes page."""
17
- ctx.run(f"{ENV_PREFIX}mknodes build")
17
+ args_str = " " + " ".join(args) if args else ""
18
+ ctx.run(f"{ENV_PREFIX}mknodes build{args_str}")
18
19
 
19
20
 
20
21
  @duty(capture=False)
21
- def serve(ctx, args: str | None = None):
22
+ def serve(ctx, *args: str):
22
23
  """Serve a MkNodes page."""
23
- args = f" {args}" if args else ""
24
- ctx.run(f"{ENV_PREFIX}mknodes serve{args}")
24
+ args_str = " " + " ".join(args) if args else ""
25
+ ctx.run(f"{ENV_PREFIX}mknodes serve{args_str}")
25
26
 
26
27
 
27
28
  @duty(capture=False)
28
- def test(ctx, args: str | None = None):
29
+ def test(ctx, *args: str):
29
30
  """Serve a MkNodes page."""
30
- args = f" {args}" if args else ""
31
- ctx.run(f"{ENV_PREFIX}pytest{args}")
31
+ args_str = " " + " ".join(args) if args else ""
32
+ ctx.run(f"{ENV_PREFIX}pytest{args_str}")
32
33
 
33
34
 
34
35
  @duty(capture=False)
@@ -38,15 +39,16 @@ def clean(ctx):
38
39
 
39
40
 
40
41
  @duty
41
- def update(ctx):
42
+ def update(ctx, *args: str):
42
43
  """Update all environment packages using pip directly."""
43
- requirements = ctx.run(UPDATE_CMD)
44
+ args_str = " " + " ".join(args) if args else ""
45
+ requirements = ctx.run(UPDATE_CMD + args_str)
44
46
  requirements = "\n".join(requirements.split("\n")[1:])
45
47
  packages = [x["name"] for x in json.loads(requirements)]
46
48
  if packages:
47
- package_str = " ".join(packages)
48
- print(f"Packages to update: {package_str}")
49
- ctx.run(f"{ENV_PREFIX}python -m pip install -U {package_str}", capture=False)
49
+ pkgs = " ".join(packages)
50
+ print(f"Packages to update: {pkgs}")
51
+ ctx.run(f"{ENV_PREFIX}python -m pip install -U {pkgs}{args_str}", capture=False)
50
52
  else:
51
53
  print("No packages to update!")
52
54
  ctx.run(f"{ENV_PREFIX}python -m pip install -e .", capture=False)
@@ -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.6"
@@ -88,7 +88,7 @@ def update_nav_template(nav: mk.MkNav):
88
88
  def process_resources(page: mk.MkPage) -> resources.Resources:
89
89
  """Add resources from page to its template and return the "filtered" resources."""
90
90
  req = page.get_resources()
91
- js_reqs = []
91
+ js_reqs: list[resources.JSFile] = []
92
92
  prefix = "../" * (len(page.resolved_parts) + 1)
93
93
  for i in req.js:
94
94
  if isinstance(i, resources.JSText):
@@ -109,10 +109,14 @@ def process_resources(page: mk.MkPage) -> resources.Resources:
109
109
  req.assets += assets
110
110
  req.js = []
111
111
  for lib in libs:
112
+ msg = f"Adding {lib.link!r} lib to {page.resolved_file_path!r} template"
113
+ logger.info(msg)
112
114
  page.template.libs.add_script_file(lib)
113
115
  for lib in non_libs:
116
+ msg = f"Adding {lib.link!r} script to {page.resolved_file_path!r} template"
117
+ logger.info(msg)
114
118
  page.template.scripts.add_script_file(lib)
115
- css_reqs = []
119
+ css_reqs: list[resources.CSSFile] = []
116
120
  for i in req.css:
117
121
  if isinstance(i, resources.CSSText):
118
122
  css_file = resources.CSSFile(link=f"{prefix}assets/{i.resolved_filename}")
@@ -123,6 +127,8 @@ def process_resources(page: mk.MkPage) -> resources.Resources:
123
127
  req.assets += assets
124
128
  req.css = []
125
129
  for css_ in css_reqs:
130
+ msg = f"Adding {css_.link!r} stylesheet to {page.resolved_file_path!r} template"
131
+ logger.info(msg)
126
132
  page.template.styles.add_stylesheet(css_)
127
133
  return req
128
134
 
@@ -202,7 +208,11 @@ class BuildCollector:
202
208
  i.template if isinstance(i, mk.MkPage) else i.page_template
203
209
  for i in self.mapping.values()
204
210
  ]
205
- templates += theme.templates
211
+ if isinstance(theme.templates, dict):
212
+ vals = theme.templates.values()
213
+ else:
214
+ vals = theme.templates
215
+ templates += list(vals)
206
216
  templates = [i for i in templates if i]
207
217
  build_files = self.node_files | self.extra_files
208
218
  for backend in self.backends:
@@ -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
 
@@ -21,7 +21,7 @@ from mkdocs.structure.files import InclusionLevel, _set_exclusions, get_files
21
21
  from mkdocs.structure.nav import get_navigation
22
22
  from mkdocs.structure.pages import Page
23
23
  from mknodes.info import mkdocsconfigfile
24
- from mknodes.utils import yamlhelpers
24
+ from mknodes.utils import pathhelpers, yamlhelpers
25
25
 
26
26
 
27
27
  if TYPE_CHECKING:
@@ -34,7 +34,7 @@ logger = get_plugin_logger(__name__)
34
34
  def build(
35
35
  config_path: str | os.PathLike,
36
36
  repo_path: str,
37
- build_fn,
37
+ build_fn: str | None,
38
38
  site_dir: str | None = None,
39
39
  clone_depth: int = 100,
40
40
  **kwargs,
@@ -133,7 +133,7 @@ def _build(
133
133
 
134
134
  if not dirty:
135
135
  logger.info("Cleaning site directory")
136
- utils.clean_directory(config.site_dir)
136
+ pathhelpers.clean_directory(config.site_dir)
137
137
  else: # pragma: no cover
138
138
  logger.warning("A 'dirty' build is being performed (for site dev purposes only)")
139
139
  if not live_server_url: # pragma: no cover
@@ -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:
@@ -27,6 +27,5 @@ class Build:
27
27
 
28
28
  def build(project: mk.Project[mk.MaterialTheme]) -> mk.MkNav:
29
29
  build = Build()
30
- project.context.env.add_template_path("mkdocs_mknodes/resources")
31
30
  build.on_theme(project.theme)
32
31
  return build.on_root(project.root) or project.root
@@ -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]:
@@ -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
 
@@ -247,6 +248,10 @@ extend-exclude = [
247
248
  ]
248
249
  target-version = "py311"
249
250
 
251
+ [tool.ruff.format]
252
+ # Enable preview style formatting.
253
+ preview = true
254
+
250
255
  [tool.ruff.flake8-quotes]
251
256
  docstring-quotes = "double"
252
257
 
@@ -1,24 +0,0 @@
1
- INHERIT: mkdocs_shared.yml
2
-
3
- site_name: MkDocstrings
4
- site_description: A MkDocstrings page created by MkNodes
5
- repo_url: "https://github.com/mkdocstrings/mkdocstrings/"
6
- site_url: https://phil65.github.io/mknodes/mkdocstrings/
7
- plugins:
8
- - mknodes:
9
- repo_path: https://github.com/mkdocstrings/mkdocstrings.git
10
- clone_depth: 100
11
- build_fn: mknodes.navs.mkemptywebsite:MkEmptyWebsite.for_project
12
- kwargs:
13
- static_pages:
14
- Development:
15
- - Changelog: ->MkChangelog
16
- - Code of conduct: ->MkCodeOfConduct
17
- - Commit conventions: ->MkCommitConventions
18
- - Pull requests: ->MkPullRequestGuidelines
19
- - Development environment: ->MkDevEnvSetup
20
- - Tools: ->MkDevTools
21
- - Dependencies: ->MkDependencyTable
22
- - Module overview: ->MkModuleOverview
23
- - Plugin flow: ->MkPluginFlow
24
- - License: ->MkLicense
@@ -1 +0,0 @@
1
- __version__ = "0.3.4"
File without changes