mkdocs-mknodes 0.4.5__tar.gz → 0.4.7__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 (68) hide show
  1. mkdocs_mknodes-0.4.7/.github/dependabot.yml +10 -0
  2. mkdocs_mknodes-0.4.7/.github/workflows/build.yml +83 -0
  3. mkdocs_mknodes-0.4.7/.github/workflows/documentation.yml +61 -0
  4. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/.pre-commit-config.yaml +6 -6
  5. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/PKG-INFO +3 -3
  6. mkdocs_mknodes-0.4.7/duties.py +67 -0
  7. mkdocs_mknodes-0.4.7/mkdocs.yml +97 -0
  8. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/__init__.py +1 -1
  9. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/backends/markdownbackend.py +1 -1
  10. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/backends/mkdocsbackend.py +6 -6
  11. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/buildcollector.py +0 -2
  12. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/buildcontext.py +0 -1
  13. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/commands/build_page.py +25 -60
  14. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/commands/serve.py +1 -2
  15. mkdocs_mknodes-0.4.7/mkdocs_mknodes/commands/utils.py +158 -0
  16. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/manual/root.py +0 -1
  17. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/manual/use_cases_section.py +0 -1
  18. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/mkdocsconfig.py +8 -8
  19. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/mknodesconfig.py +4 -1
  20. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/plugin/__init__.py +19 -5
  21. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/plugin/mkdocsbuilder.py +5 -6
  22. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/plugin/pluginconfig.py +11 -7
  23. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/pyproject.toml +50 -97
  24. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/tests/test_cli.py +0 -1
  25. mkdocs_mknodes-0.4.5/.github/workflows/build.yml +0 -70
  26. mkdocs_mknodes-0.4.5/.github/workflows/documentation.yml +0 -60
  27. mkdocs_mknodes-0.4.5/duties.py +0 -73
  28. mkdocs_mknodes-0.4.5/mkdocs.yml +0 -96
  29. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/.editorconfig +0 -0
  30. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/.github/README.md +0 -0
  31. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/.gitignore +0 -0
  32. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/LICENSE +0 -0
  33. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/README.md +0 -0
  34. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/configs/mkdocs_mkdocs.yml +0 -0
  35. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/configs/mkdocs_shared.yml +0 -0
  36. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/docs/assets/cli.gif +0 -0
  37. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/docs/build_process.jinja +0 -0
  38. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/docs/cli_index.jinja +0 -0
  39. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/docs/github_index.jinja +0 -0
  40. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/docs/index.jinja +0 -0
  41. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/docs/plugin_configuration.jinja +0 -0
  42. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/docs/use_case_by_config.jinja +0 -0
  43. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/docs/use_case_default_website.jinja +0 -0
  44. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/docs/use_cases_index.jinja +0 -0
  45. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/docs/why_should_i_use_mknodes.jinja +0 -0
  46. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/backends/__init__.py +0 -0
  47. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/backends/buildbackend.py +0 -0
  48. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/cli/__init__.py +0 -0
  49. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/cli/richstate.py +0 -0
  50. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/commands/__init__.py +0 -0
  51. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/manual/__init__.py +0 -0
  52. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/manual/cli_section.py +0 -0
  53. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/manual/get_started_section.py +0 -0
  54. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/manual/github_index.py +0 -0
  55. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/mkdefaultwebsite.py +0 -0
  56. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/paths.py +0 -0
  57. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
  58. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
  59. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/py.typed +0 -0
  60. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
  61. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
  62. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/mkdocs_mknodes.sublime-project +0 -0
  63. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/overrides/_dummy.txt +0 -0
  64. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/overrides/partials/actions.html +0 -0
  65. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/tests/__init__.py +0 -0
  66. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/tests/conftest.py +0 -0
  67. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/tests/data/objects.inv +0 -0
  68. {mkdocs_mknodes-0.4.5 → mkdocs_mknodes-0.4.7}/tests/test_build.py +0 -0
@@ -0,0 +1,10 @@
1
+ # Set update schedule for GitHub Actions
2
+
3
+ version: 2
4
+ updates:
5
+
6
+ - package-ecosystem: "github-actions"
7
+ directory: "/"
8
+ schedule:
9
+ # Check for updates to GitHub Actions every week
10
+ interval: "weekly"
@@ -0,0 +1,83 @@
1
+ name: Build
2
+
3
+ on: [push, pull_request]
4
+
5
+ jobs:
6
+ test:
7
+ runs-on: ubuntu-latest
8
+ strategy:
9
+ matrix:
10
+ python_version: ["3.11", "3.12", "3.13"]
11
+
12
+ steps:
13
+ - name: Check out repository
14
+ uses: actions/checkout@v4
15
+
16
+ - name: Set up Python ${{ matrix.python_version }}
17
+ uses: actions/setup-python@v5
18
+ with:
19
+ python-version: ${{ matrix.python_version }}
20
+
21
+ - name: Install uv
22
+ uses: yezz123/setup-uv@v4
23
+
24
+ - name: Setup Graphviz
25
+ uses: ts-graphviz/setup-graphviz@v2
26
+
27
+ - name: Install dependencies
28
+ run: |
29
+ uv sync --all-extras
30
+
31
+ - name: Lint and typecheck
32
+ run: |
33
+ uv run ruff check .
34
+ uv run ruff format --check .
35
+ uv run mypy mkdocs_mknodes/
36
+
37
+ - name: Test
38
+ run: |
39
+ uv run pytest --cov-report=xml
40
+
41
+ - uses: codecov/codecov-action@v4
42
+ with:
43
+ token: ${{ secrets.CODECOV_TOKEN }}
44
+ fail_ci_if_error: false
45
+ verbose: true
46
+
47
+ release:
48
+ runs-on: ubuntu-latest
49
+ needs: test
50
+ if: startsWith(github.ref, 'refs/tags/')
51
+ permissions:
52
+ # IMPORTANT: this permission is mandatory for trusted publishing
53
+ id-token: write
54
+ contents: write
55
+ steps:
56
+ - name: Check out repository
57
+ uses: actions/checkout@v4
58
+
59
+ - name: Set up Python 3.12
60
+ uses: actions/setup-python@v5
61
+ with:
62
+ python-version: "3.12"
63
+
64
+ - name: Install uv
65
+ uses: yezz123/setup-uv@v4
66
+
67
+ - name: Build package
68
+ run: |
69
+ uv build
70
+
71
+ - name: Publish package on PyPI
72
+ env:
73
+ UV_PUBLISH_TOKEN: ${{ secrets.UV_PUBLISH_TOKEN }}
74
+ run: |
75
+ uv publish
76
+
77
+ - name: Publish package on GitHub
78
+ uses: ncipollo/release-action@v1
79
+ with:
80
+ draft: true
81
+ body: ${{ github.event.head_commit.message }}
82
+ artifacts: dist/*.whl,dist/*.tar.gz
83
+ token: ${{ secrets.GITHUB_TOKEN }}
@@ -0,0 +1,61 @@
1
+ name: Build documentation
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+
8
+ # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
9
+ permissions:
10
+ contents: read
11
+ pages: write
12
+ id-token: write
13
+
14
+ # Allow one concurrent deployment
15
+ concurrency:
16
+ group: "pages"
17
+ cancel-in-progress: true
18
+
19
+ # Default to bash
20
+ defaults:
21
+ run:
22
+ shell: bash
23
+
24
+ jobs:
25
+ build:
26
+ runs-on: ubuntu-latest
27
+
28
+ steps:
29
+ - uses: actions/checkout@v4
30
+ with:
31
+ fetch-depth: 0
32
+ - name: Set up Python
33
+ uses: actions/setup-python@v5
34
+ with:
35
+ python-version: "3.11"
36
+ - name: Setup Graphviz
37
+ uses: ts-graphviz/setup-graphviz@v2
38
+ - name: Install uv
39
+ uses: yezz123/setup-uv@v4
40
+ - name: Install dependencies
41
+ run: |
42
+ uv sync --all-extras
43
+ - name: Build
44
+ run: |
45
+ uv run mkdocs build -v
46
+ uv run mknodes build -d ../site/mkdocs -p configs/mkdocs_mkdocs.yml -v --clone-depth 100
47
+ - name: Upload artifact
48
+ uses: actions/upload-pages-artifact@v3
49
+ with:
50
+ path: ./site
51
+
52
+ deploy:
53
+ environment:
54
+ name: github-pages
55
+ url: ${{ steps.deployment.outputs.page_url }}
56
+ runs-on: ubuntu-latest
57
+ needs: build
58
+ steps:
59
+ - name: Deploy to GitHub Pages
60
+ id: deployment
61
+ uses: actions/deploy-pages@v4
@@ -1,19 +1,19 @@
1
1
  default_language_version:
2
2
  python: python3.11
3
- default_stages: [commit]
3
+ default_stages: [pre-commit]
4
4
  repos:
5
5
  - repo: local
6
6
  hooks:
7
7
  - id: pytest-check
8
8
  name: pytest-check
9
- entry: hatch run test
9
+ entry: uv run pytest
10
10
  language: system
11
11
  # stages: [push]
12
12
  types: [python]
13
13
  pass_filenames: false
14
14
  always_run: true
15
15
  - repo: https://github.com/pre-commit/pre-commit-hooks
16
- rev: v4.5.0
16
+ rev: v5.0.0
17
17
  hooks:
18
18
  # - id: trailing-whitespace
19
19
  # - id: check-ast
@@ -29,20 +29,20 @@ repos:
29
29
  # https://pre-commit.com/hooks.html
30
30
 
31
31
  - repo: https://github.com/pre-commit/mirrors-mypy
32
- rev: v1.7.0
32
+ rev: v1.12.0
33
33
  hooks:
34
34
  - id: mypy
35
35
  # args: [--ignore-missing-imports]
36
36
  additional_dependencies: [mkdocs]
37
37
 
38
38
  - repo: https://github.com/charliermarsh/ruff-pre-commit
39
- rev: v0.1.6
39
+ rev: v0.6.9
40
40
  hooks:
41
41
  - id: ruff
42
42
  - id: ruff-format
43
43
 
44
44
  - repo: https://github.com/commitizen-tools/commitizen
45
- rev: 3.12.0
45
+ rev: v3.29.1
46
46
  hooks:
47
47
  - id: commitizen
48
48
  stages: [commit-msg]
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.3
2
2
  Name: mkdocs-mknodes
3
- Version: 0.4.5
3
+ Version: 0.4.7
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
@@ -11,7 +11,6 @@ License-File: LICENSE
11
11
  Keywords: docs,docstrings,documentation,framework,internet,markdown
12
12
  Classifier: Development Status :: 4 - Beta
13
13
  Classifier: Intended Audience :: Developers
14
- Classifier: License :: OSI Approved :: MIT License
15
14
  Classifier: Operating System :: OS Independent
16
15
  Classifier: Programming Language :: Python :: 3
17
16
  Classifier: Programming Language :: Python :: 3 :: Only
@@ -28,6 +27,7 @@ Requires-Dist: jinja2
28
27
  Requires-Dist: jinjarope
29
28
  Requires-Dist: mkdocs>=1.5
30
29
  Requires-Dist: mknodes
30
+ Requires-Dist: pathspec
31
31
  Requires-Dist: rich
32
32
  Requires-Dist: typer
33
33
  Requires-Dist: universal-pathlib
@@ -0,0 +1,67 @@
1
+ from __future__ import annotations
2
+
3
+ from duty import duty
4
+
5
+
6
+ @duty(capture=False)
7
+ def build(ctx, *args: str):
8
+ """Build a MkNodes page."""
9
+ args_str = " " + " ".join(args) if args else ""
10
+ ctx.run(f"uv run mknodes build{args_str}")
11
+
12
+
13
+ @duty(capture=False)
14
+ def serve(ctx, *args: str):
15
+ """Serve a MkNodes page."""
16
+ args_str = " " + " ".join(args) if args else ""
17
+ ctx.run(f"uv run mknodes serve{args_str}")
18
+
19
+
20
+ @duty(capture=False)
21
+ def test(ctx, *args: str):
22
+ """Serve a MkNodes page."""
23
+ args_str = " " + " ".join(args) if args else ""
24
+ ctx.run(f"uv run pytest{args_str}")
25
+
26
+
27
+ @duty(capture=False)
28
+ def clean(ctx):
29
+ """Clean all files from the Git directory except checked-in files."""
30
+ ctx.run("git clean -dfX")
31
+
32
+
33
+ @duty(capture=False)
34
+ def update(ctx):
35
+ """Update all environment packages using pip directly."""
36
+ ctx.run("uv sync --all-extras")
37
+
38
+
39
+ @duty(capture=False)
40
+ def lint(ctx):
41
+ """Lint the code and fix issues if possible."""
42
+ ctx.run("uv run ruff check --fix .")
43
+ ctx.run("uv run ruff format .")
44
+ ctx.run("uv run mypy mkdocs_mknodes/")
45
+
46
+
47
+ @duty(capture=False)
48
+ def lint_check(ctx):
49
+ """Lint the code."""
50
+ ctx.run("uv run ruff check .")
51
+ ctx.run("uv run ruff format --check .")
52
+ ctx.run("uv run mypy mkdocs_mknodes/")
53
+
54
+
55
+ @duty(capture=False)
56
+ def docs_test_build(ctx):
57
+ """Build some test pages."""
58
+ ctx.run("uv run mkdocs build -v")
59
+ opts = "-d ../site/mkdocs -p configs/mkdocs_mkdocs.yml -v --clone-depth 100"
60
+ ctx.run(f"uv run mknodes build {opts}")
61
+
62
+
63
+ @duty(capture=False)
64
+ def version(ctx, *args: str):
65
+ """Bump package version."""
66
+ args_str = " " + " ".join(args) if args else ""
67
+ ctx.run(f"hatch version{args_str}")
@@ -0,0 +1,97 @@
1
+ site_name: MkNodes (MkDocs plugin)
2
+ site_description: "Don´t write docs. Code them."
3
+ repo_url: "https://github.com/phil65/mkdocs_mknodes/"
4
+ site_url: https://phil65.github.io/mkdocs-mknodes/
5
+ site_author: Philipp Temminghoff
6
+ copyright: Copyright © 2023 Philipp Temminghoff
7
+
8
+ theme:
9
+ name: material
10
+ custom_dir: overrides
11
+ icon:
12
+ logo: material/graph-outline
13
+ palette:
14
+ # Palette toggle for light mode
15
+ - media: "(prefers-color-scheme: light)"
16
+ scheme: default
17
+ primary: custom
18
+ toggle:
19
+ icon: material/brightness-7
20
+ name: Switch to dark mode
21
+
22
+ # Palette toggle for dark mode
23
+ - media: "(prefers-color-scheme: dark)"
24
+ scheme: slate
25
+ primary: custom
26
+ toggle:
27
+ icon: material/brightness-4
28
+ name: Switch to light mode
29
+ features:
30
+ - announce.dismiss
31
+ - content.action.edit
32
+ - content.code.copy
33
+ - content.code.select
34
+ - content.code.annotate
35
+ # - content.tooltips # for insiders..
36
+ # - content.tabs.link
37
+ - navigation.tracking # update URL based on current item in TOC
38
+ - navigation.path # shows breadcrumbs
39
+ - navigation.tabs # make top level tabs
40
+ - navigation.indexes # documents can be directly attached to sections (overview pages)
41
+ - navigation.footer # next/previous page buttons in footer
42
+ - navigation.top # adds back-to-top button
43
+ # - navigation.sections # top-level sections are rendered as groups
44
+ # - navigation.expand # expand all subsections in left sidebar by default
45
+ - toc.follow # makes toc follow scrolling
46
+ # - toc.integrate # integrates toc into left menu
47
+ - search.highlight
48
+ - search.suggest
49
+ # - search.share
50
+
51
+ plugins:
52
+ - search
53
+ - mknodes:
54
+ build_fn: mkdocs_mknodes.manual.root:Build.build
55
+ show_page_info: true
56
+ global_resources: false
57
+ - mkdocstrings:
58
+ default_handler: python
59
+ handlers:
60
+ python:
61
+ import:
62
+ - url: https://docs.python.org/3/objects.inv
63
+ domains: [std, py]
64
+ - url: https://phil65.github.io/mknodes/objects.inv
65
+ domains: [std, py]
66
+ options:
67
+ extensions:
68
+ - griffe_fieldz: { include_inherited: true }
69
+ # https://mkdocstrings.github.io/python/usage/
70
+ show_signature_annotations: true
71
+ show_symbol_type_toc: true
72
+ show_symbol_type_heading: true
73
+ show_root_toc_entry: false
74
+ # merge_init_into_class: true
75
+ ignore_init_summary: true
76
+ inherited_members: false
77
+ signature_crossrefs: true
78
+ separate_signature: true
79
+ line_length: 90
80
+ preload_modules:
81
+ - mknodes
82
+ markdown_extensions:
83
+ - attr_list
84
+ - pymdownx.emoji
85
+ - toc:
86
+ permalink: true
87
+ # extra:
88
+ # social:
89
+ # - icon: fontawesome/brands/github
90
+ # link: https://github.com/phil65
91
+ # - icon: fontawesome/brands/gitter
92
+ # link: https://matrix.to/#/#mknodes:gitter.im
93
+ # - icon: fontawesome/brands/python
94
+ # link: https://pypi.org/project/mknodes/
95
+ # generator: false disable "made with Material"
96
+ # version: # multiple doc versions
97
+ # provider: mike
@@ -1,4 +1,4 @@
1
- __version__ = "0.4.5"
1
+ __version__ = "0.4.7"
2
2
 
3
3
 
4
4
  from .mkdefaultwebsite import MkDefaultWebsite
@@ -14,7 +14,7 @@ logger = log.get_logger(__name__)
14
14
  class MarkdownBackend(buildbackend.BuildBackend):
15
15
  def __init__(
16
16
  self,
17
- directory: str | os.PathLike | None = None,
17
+ directory: str | os.PathLike[str] | None = None,
18
18
  extension: str = ".md",
19
19
  ):
20
20
  """Constructor.
@@ -4,13 +4,13 @@ import collections
4
4
  import os
5
5
  import pathlib
6
6
 
7
+ from jinjarope import serializefilters
7
8
  import markdown
8
-
9
9
  from mkdocs.config import config_options
10
10
  from mkdocs.config.defaults import MkDocsConfig
11
11
  from mkdocs.plugins import get_plugin_logger
12
12
  from mkdocs.structure import files as files_
13
- from mknodes.utils import mergehelpers, pathhelpers, resources
13
+ from mknodes.utils import pathhelpers, resources
14
14
  import upath
15
15
 
16
16
  from mkdocs_mknodes import mkdocsconfig
@@ -25,8 +25,8 @@ class MkDocsBackend(buildbackend.BuildBackend):
25
25
  def __init__(
26
26
  self,
27
27
  files: files_.Files | None = None,
28
- config: mkdocsconfig.Config | MkDocsConfig | str | os.PathLike | None = None,
29
- directory: str | os.PathLike | None = None,
28
+ config: mkdocsconfig.Config | MkDocsConfig | str | os.PathLike[str] | None = None,
29
+ directory: str | os.PathLike[str] | None = None,
30
30
  ):
31
31
  """Constructor.
32
32
 
@@ -123,7 +123,7 @@ class MkDocsBackend(buildbackend.BuildBackend):
123
123
  if ext_name not in self._config.markdown_extensions:
124
124
  logger.info("Adding %s to extensions", ext_name)
125
125
  self._config.markdown_extensions.append(ext_name)
126
- self._config.mdx_configs = mergehelpers.merge_dicts(
126
+ self._config.mdx_configs = serializefilters.merge(
127
127
  self._config.mdx_configs,
128
128
  extensions,
129
129
  )
@@ -140,7 +140,7 @@ class MkDocsBackend(buildbackend.BuildBackend):
140
140
  logger.info("Creating %s...", target_path.as_posix())
141
141
  pathhelpers.write_file(html, target_path)
142
142
 
143
- def _write_file(self, path: str | os.PathLike, content: str | bytes):
143
+ def _write_file(self, path: str | os.PathLike[str], content: str | bytes):
144
144
  path = pathlib.PurePath(path).as_posix()
145
145
  file_for_path = self.builder.get_file(path, src_dir=self.directory)
146
146
  new_path = upath.UPath(file_for_path.abs_src_path)
@@ -6,11 +6,9 @@ import collections
6
6
  import itertools
7
7
  import pathlib
8
8
  import pprint
9
-
10
9
  from typing import TYPE_CHECKING
11
10
 
12
11
  import mknodes as mk
13
-
14
12
  from mknodes.utils import log, resources
15
13
 
16
14
  from mkdocs_mknodes import buildcontext
@@ -6,7 +6,6 @@ import collections
6
6
  import dataclasses
7
7
 
8
8
  import mknodes as mk
9
-
10
9
  from mknodes.info import contexts
11
10
  from mknodes.utils import log, resources
12
11
 
@@ -2,27 +2,22 @@
2
2
 
3
3
  from __future__ import annotations
4
4
 
5
- from collections.abc import Callable
6
- import functools
7
5
  import io
8
- import logging
9
6
  import os
10
- import time
11
-
12
7
  from typing import TYPE_CHECKING, Any
13
8
  from urllib.parse import urljoin
14
9
 
15
- from mkdocs import utils
16
10
  from mkdocs.commands import build as mkdocs_build
17
11
  from mkdocs.config import load_config
18
- from mkdocs.exceptions import Abort, BuildError
19
12
  from mkdocs.plugins import get_plugin_logger
20
- from mkdocs.structure.files import InclusionLevel, _set_exclusions, get_files
13
+ from mkdocs.structure.files import InclusionLevel
21
14
  from mkdocs.structure.nav import get_navigation
22
15
  from mkdocs.structure.pages import Page
23
16
  from mknodes.info import mkdocsconfigfile
24
17
  from mknodes.utils import pathhelpers, yamlhelpers
25
18
 
19
+ from mkdocs_mknodes.commands import utils
20
+
26
21
 
27
22
  if TYPE_CHECKING:
28
23
  from mkdocs.config.defaults import MkDocsConfig
@@ -32,7 +27,7 @@ logger = get_plugin_logger(__name__)
32
27
 
33
28
 
34
29
  def build(
35
- config_path: str | os.PathLike,
30
+ config_path: str | os.PathLike[str],
36
31
  repo_path: str,
37
32
  build_fn: str | None,
38
33
  site_dir: str | None = None,
@@ -68,50 +63,8 @@ def build(
68
63
  config.plugins.run_event("shutdown")
69
64
 
70
65
 
71
- def count_warnings(fn: Callable) -> Callable:
72
- @functools.wraps(fn)
73
- def wrapped(config: MkDocsConfig, *args, **kwargs):
74
- start = time.monotonic()
75
- warning_counter = utils.CountHandler()
76
- warning_counter.setLevel(logging.WARNING)
77
- if config.strict:
78
- logging.getLogger("mkdocs").addHandler(warning_counter)
79
- result = fn(config, *args, **kwargs)
80
- counts = warning_counter.get_counts()
81
- if counts:
82
- msg = ", ".join(f"{v} {k.lower()}s" for k, v in counts)
83
- msg = f"Aborted with {msg} in strict mode!"
84
- raise Abort(msg)
85
- duration = time.monotonic() - start
86
- logger.info("Documentation built in %.2f seconds", duration)
87
- logging.getLogger("mkdocs").removeHandler(warning_counter)
88
-
89
- return result
90
-
91
- return wrapped
92
-
93
-
94
- def handle_exceptions(fn: Callable) -> Callable:
95
- @functools.wraps(fn)
96
- def wrapped(config: MkDocsConfig, *args, **kwargs):
97
- try:
98
- return fn(config, *args, **kwargs)
99
- except Exception as e:
100
- # Run `build_error` plugin events.
101
- config.plugins.on_build_error(error=e)
102
- if isinstance(e, BuildError):
103
- msg = "Aborted with a BuildError!"
104
- logger.exception(msg)
105
- raise Abort(msg) from e
106
- raise
107
- # finally:
108
- # logging.getLogger("mkdocs").removeHandler(warning_counter)
109
-
110
- return wrapped
111
-
112
-
113
- @handle_exceptions
114
- @count_warnings
66
+ @utils.handle_exceptions
67
+ @utils.count_warnings
115
68
  def _build(
116
69
  config: MkDocsConfig,
117
70
  live_server_url: str | None = None,
@@ -127,7 +80,9 @@ def _build(
127
80
  live_server_url: An optional URL of the live server to use
128
81
  dirty: Do a dirty build
129
82
  """
130
- inclusion = InclusionLevel.all if live_server_url else InclusionLevel.is_included
83
+ inclusion = (
84
+ InclusionLevel.is_in_serve if live_server_url else InclusionLevel.is_included
85
+ )
131
86
  config = config.plugins.on_config(config)
132
87
  config.plugins.on_pre_build(config=config)
133
88
 
@@ -142,21 +97,21 @@ def _build(
142
97
  logger.info("The directory contains stale files. Use --clean to remove them.")
143
98
  # First gather all data from all files/pages to ensure all data is
144
99
  # consistent across all pages.
145
- files = get_files(config)
100
+ files = utils.get_files(config)
146
101
  env = config.theme.get_env()
147
102
  files.add_files_from_theme(env, config)
148
103
  files = config.plugins.on_files(files, config=config)
149
104
  # If plugins have added files without setting inclusion level, calculate it again.
150
- _set_exclusions(files._files, config)
105
+ utils.set_exclusions(files._files, config)
151
106
  nav = get_navigation(files, config)
152
107
  # Run `nav` plugin events.
153
108
  nav = config.plugins.on_nav(nav, config=config, files=files)
154
109
  logger.debug("Reading markdown pages.")
155
- excluded = []
110
+ excluded: list[str] = []
156
111
  for file in files.documentation_pages(inclusion=inclusion):
157
112
  logger.debug("Reading: %s", file.src_uri)
158
- if file.page is None and file.inclusion.is_excluded():
159
- if live_server_url:
113
+ if file.page is None and file.inclusion.is_not_in_nav():
114
+ if live_server_url and file.inclusion.is_excluded():
160
115
  excluded.append(urljoin(live_server_url, file.url))
161
116
  Page(None, file, config)
162
117
  assert file.page is not None
@@ -165,7 +120,7 @@ def _build(
165
120
  excluded_str = "\n - ".join(excluded)
166
121
  logger.info(
167
122
  "The following pages are being built only for the preview "
168
- "but will be excluded from `mkdocs build` per `exclude_docs`:"
123
+ "but will be excluded from `mkdocs build` per `draft_docs` config:"
169
124
  "\n - %s",
170
125
  excluded_str,
171
126
  )
@@ -185,5 +140,15 @@ def _build(
185
140
  excl = file.inclusion.is_excluded()
186
141
  mkdocs_build._build_page(file.page, config, doc_files, nav, env, dirty, excl)
187
142
 
143
+ log_level = config.validation.links.anchors
144
+ for file in doc_files:
145
+ assert file.page is not None
146
+ file.page.validate_anchor_links(files=files, log_level=log_level)
188
147
  # Run `post_build` plugin events.
189
148
  config.plugins.on_post_build(config=config)
149
+
150
+
151
+ if __name__ == "__main__":
152
+ config = mkdocsconfigfile.MkDocsConfigFile("mkdocs.yml")
153
+ print(config.dump_config())
154
+ build("mkdocs.yml", ".", "mkdocs_mknodes.manual.root:Build.build")
@@ -6,7 +6,6 @@ import os
6
6
  import pathlib
7
7
  import shutil
8
8
  import tempfile
9
-
10
9
  from typing import TYPE_CHECKING, Any, Literal
11
10
  from urllib.parse import urlsplit
12
11
 
@@ -27,7 +26,7 @@ logger = log.get_logger(__name__)
27
26
 
28
27
 
29
28
  def serve(
30
- config_path: str | os.PathLike = paths.CFG_DEFAULT,
29
+ config_path: str | os.PathLike[str] = paths.CFG_DEFAULT,
31
30
  repo_path: str = ".",
32
31
  build_fn: str = paths.DEFAULT_BUILD_FN,
33
32
  clone_depth: int = 100,