mkdocs-mknodes 0.4.7__tar.gz → 0.5.0__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.7 → mkdocs_mknodes-0.5.0}/.github/README.md +0 -2
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/.github/workflows/build.yml +4 -2
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/.github/workflows/documentation.yml +17 -10
- mkdocs_mknodes-0.5.0/.gitignore +48 -0
- mkdocs_mknodes-0.5.0/.pre-commit-config.yaml +49 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/PKG-INFO +8 -3
- mkdocs_mknodes-0.5.0/configs/mkdocs_mkdocs.yml +62 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/duties.py +1 -0
- mkdocs_mknodes-0.5.0/mkdocs_mknodes/__init__.py +17 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/backends/mkdocsbackend.py +2 -3
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/buildcollector.py +5 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/cli/__init__.py +2 -4
- mkdocs_mknodes-0.5.0/mkdocs_mknodes/commands/build_page.py +418 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/commands/utils.py +3 -2
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/mkdocsconfig.py +3 -2
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/plugin/__init__.py +3 -3
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/plugin/mkdocsbuilder.py +2 -3
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/plugin/mkdocshelpers.py +3 -2
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/plugin/pluginconfig.py +1 -1
- mkdocs_mknodes-0.5.0/mkdocs_mknodes/telemetry.py +95 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/pyproject.toml +74 -68
- mkdocs_mknodes-0.4.7/.gitignore +0 -115
- mkdocs_mknodes-0.4.7/.pre-commit-config.yaml +0 -49
- mkdocs_mknodes-0.4.7/configs/mkdocs_mkdocs.yml +0 -62
- mkdocs_mknodes-0.4.7/mkdocs_mknodes/__init__.py +0 -6
- mkdocs_mknodes-0.4.7/mkdocs_mknodes/commands/build_page.py +0 -154
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/.editorconfig +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/.github/dependabot.yml +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/LICENSE +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/README.md +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/configs/mkdocs_shared.yml +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/docs/assets/cli.gif +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/docs/build_process.jinja +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/docs/cli_index.jinja +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/docs/github_index.jinja +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/docs/index.jinja +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/docs/plugin_configuration.jinja +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/docs/use_case_by_config.jinja +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/docs/use_case_default_website.jinja +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/docs/use_cases_index.jinja +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/docs/why_should_i_use_mknodes.jinja +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs.yml +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/backends/__init__.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/backends/buildbackend.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/backends/markdownbackend.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/buildcontext.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/cli/richstate.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/commands/__init__.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/commands/serve.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/manual/__init__.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/manual/cli_section.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/manual/get_started_section.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/manual/github_index.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/manual/root.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/manual/use_cases_section.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/mkdefaultwebsite.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/mknodesconfig.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/paths.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/py.typed +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/mkdocs_mknodes.sublime-project +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/overrides/_dummy.txt +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/overrides/partials/actions.html +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/tests/__init__.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/tests/conftest.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/tests/data/objects.inv +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/tests/test_build.py +0 -0
- {mkdocs_mknodes-0.4.7 → mkdocs_mknodes-0.5.0}/tests/test_cli.py +0 -0
|
@@ -135,7 +135,6 @@ graph LR
|
|
|
135
135
|
2257955170352["mkprogressbar.MkProgressBar"]
|
|
136
136
|
2257954960512["mkcard.MkCard"]
|
|
137
137
|
2257954976128["mkinclude.MkInclude"]
|
|
138
|
-
2257952115568["mkcallable.MkCallable"]
|
|
139
138
|
2257952108736["mkcommandoutput.MkCommandOutput"]
|
|
140
139
|
2257952117520["mkjinjatemplate.MkTemplate"]
|
|
141
140
|
2257944740368 --> 2257944738416
|
|
@@ -211,7 +210,6 @@ graph LR
|
|
|
211
210
|
2257944740368 --> 2257955170352
|
|
212
211
|
2257944740368 --> 2257954960512
|
|
213
212
|
2257944740368 --> 2257954976128
|
|
214
|
-
2257944740368 --> 2257952115568
|
|
215
213
|
2257944740368 --> 2257952108736
|
|
216
214
|
2257944740368 --> 2257952117520
|
|
217
215
|
```
|
|
@@ -7,7 +7,7 @@ jobs:
|
|
|
7
7
|
runs-on: ubuntu-latest
|
|
8
8
|
strategy:
|
|
9
9
|
matrix:
|
|
10
|
-
python_version: ["3.
|
|
10
|
+
python_version: ["3.12", "3.13"]
|
|
11
11
|
|
|
12
12
|
steps:
|
|
13
13
|
- name: Check out repository
|
|
@@ -74,10 +74,12 @@ jobs:
|
|
|
74
74
|
run: |
|
|
75
75
|
uv publish
|
|
76
76
|
|
|
77
|
+
# - name: Publish package to PyPI
|
|
78
|
+
# uses: pypa/gh-action-pypi-publish@release/v1
|
|
79
|
+
|
|
77
80
|
- name: Publish package on GitHub
|
|
78
81
|
uses: ncipollo/release-action@v1
|
|
79
82
|
with:
|
|
80
|
-
draft: true
|
|
81
83
|
body: ${{ github.event.head_commit.message }}
|
|
82
84
|
artifacts: dist/*.whl,dist/*.tar.gz
|
|
83
85
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
@@ -26,25 +26,32 @@ jobs:
|
|
|
26
26
|
runs-on: ubuntu-latest
|
|
27
27
|
|
|
28
28
|
steps:
|
|
29
|
-
-
|
|
29
|
+
- name: Check out repository
|
|
30
|
+
uses: actions/checkout@v4
|
|
30
31
|
with:
|
|
31
32
|
fetch-depth: 0
|
|
32
|
-
|
|
33
|
+
|
|
34
|
+
- name: Set up Python 3.12
|
|
33
35
|
uses: actions/setup-python@v5
|
|
34
36
|
with:
|
|
35
|
-
python-version: "3.
|
|
37
|
+
python-version: "3.12"
|
|
38
|
+
|
|
36
39
|
- name: Setup Graphviz
|
|
37
40
|
uses: ts-graphviz/setup-graphviz@v2
|
|
41
|
+
|
|
38
42
|
- name: Install uv
|
|
39
43
|
uses: yezz123/setup-uv@v4
|
|
44
|
+
|
|
40
45
|
- name: Install dependencies
|
|
41
|
-
run:
|
|
42
|
-
|
|
43
|
-
- name: Build
|
|
44
|
-
run:
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
46
|
+
run: uv sync --all-extras
|
|
47
|
+
|
|
48
|
+
- name: Build main documentation page
|
|
49
|
+
run: uv run mkdocs build -v
|
|
50
|
+
|
|
51
|
+
- name: Build example sub-page (MkDocs)
|
|
52
|
+
run: uv run mknodes build -d ../site/mkdocs -p configs/mkdocs_mkdocs.yml -v --clone-depth 100
|
|
53
|
+
|
|
54
|
+
- name: Package and upload page artifact
|
|
48
55
|
uses: actions/upload-pages-artifact@v3
|
|
49
56
|
with:
|
|
50
57
|
path: ./site
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
# Distribution / packaging
|
|
8
|
+
env/
|
|
9
|
+
dist/
|
|
10
|
+
.markdown/
|
|
11
|
+
*.sublime-workspace
|
|
12
|
+
|
|
13
|
+
# Unit test / coverage reports
|
|
14
|
+
htmlcov/
|
|
15
|
+
.coverage
|
|
16
|
+
.coverage.*
|
|
17
|
+
.cache
|
|
18
|
+
coverage.xml
|
|
19
|
+
.hypothesis/
|
|
20
|
+
.pytest_cache/
|
|
21
|
+
junit/
|
|
22
|
+
junit.xml
|
|
23
|
+
|
|
24
|
+
# pyenv
|
|
25
|
+
.python-version
|
|
26
|
+
|
|
27
|
+
# dotenv
|
|
28
|
+
.env
|
|
29
|
+
|
|
30
|
+
# virtualenv
|
|
31
|
+
.venv
|
|
32
|
+
venv/
|
|
33
|
+
ENV/
|
|
34
|
+
|
|
35
|
+
# mkdocs documentation
|
|
36
|
+
/site
|
|
37
|
+
|
|
38
|
+
# mypy
|
|
39
|
+
.mypy_cache/
|
|
40
|
+
|
|
41
|
+
# .vscode
|
|
42
|
+
.vscode/
|
|
43
|
+
|
|
44
|
+
# PyCharm
|
|
45
|
+
.idea/
|
|
46
|
+
|
|
47
|
+
# OS files
|
|
48
|
+
.DS_Store
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
default_language_version:
|
|
2
|
+
python: python3.12
|
|
3
|
+
default_stages: [pre-commit]
|
|
4
|
+
repos:
|
|
5
|
+
- repo: local
|
|
6
|
+
hooks:
|
|
7
|
+
- id: pytest-check
|
|
8
|
+
name: pytest-check
|
|
9
|
+
entry: uv run pytest
|
|
10
|
+
language: system
|
|
11
|
+
# stages: [push]
|
|
12
|
+
types: [python]
|
|
13
|
+
pass_filenames: false
|
|
14
|
+
always_run: true
|
|
15
|
+
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
16
|
+
rev: v5.0.0
|
|
17
|
+
hooks:
|
|
18
|
+
# - id: trailing-whitespace
|
|
19
|
+
# - id: check-ast
|
|
20
|
+
- id: check-case-conflict
|
|
21
|
+
- id: check-docstring-first
|
|
22
|
+
- id: check-merge-conflict
|
|
23
|
+
# - id: check-yaml
|
|
24
|
+
- id: check-toml
|
|
25
|
+
- id: check-json
|
|
26
|
+
- id: detect-private-key
|
|
27
|
+
- id: forbid-new-submodules
|
|
28
|
+
# - id: check-added-large-files
|
|
29
|
+
# https://pre-commit.com/hooks.html
|
|
30
|
+
|
|
31
|
+
- repo: https://github.com/pre-commit/mirrors-mypy
|
|
32
|
+
rev: v1.13.0
|
|
33
|
+
hooks:
|
|
34
|
+
- id: mypy
|
|
35
|
+
# args: [--ignore-missing-imports]
|
|
36
|
+
additional_dependencies: [mkdocs, orjson]
|
|
37
|
+
|
|
38
|
+
- repo: https://github.com/charliermarsh/ruff-pre-commit
|
|
39
|
+
rev: v0.7.1
|
|
40
|
+
hooks:
|
|
41
|
+
- id: ruff
|
|
42
|
+
- id: ruff-format
|
|
43
|
+
|
|
44
|
+
- repo: https://github.com/commitizen-tools/commitizen
|
|
45
|
+
rev: v3.30.0
|
|
46
|
+
hooks:
|
|
47
|
+
- id: commitizen
|
|
48
|
+
stages: [commit-msg]
|
|
49
|
+
additional_dependencies: [typing-extensions]
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.3
|
|
2
2
|
Name: mkdocs-mknodes
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.5.0
|
|
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
|
|
@@ -14,20 +14,25 @@ Classifier: Intended Audience :: Developers
|
|
|
14
14
|
Classifier: Operating System :: OS Independent
|
|
15
15
|
Classifier: Programming Language :: Python :: 3
|
|
16
16
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
17
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
18
17
|
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
19
19
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
20
20
|
Classifier: Topic :: Documentation
|
|
21
21
|
Classifier: Topic :: Internet
|
|
22
22
|
Classifier: Topic :: Software Development :: Documentation
|
|
23
23
|
Classifier: Topic :: Software Development :: User Interfaces
|
|
24
24
|
Classifier: Topic :: Text Processing :: Markup :: Markdown
|
|
25
|
-
Requires-Python: >=3.
|
|
25
|
+
Requires-Python: >=3.12
|
|
26
26
|
Requires-Dist: jinja2
|
|
27
27
|
Requires-Dist: jinjarope
|
|
28
|
+
Requires-Dist: logfire[aiohttp,requests,system-metrics]
|
|
28
29
|
Requires-Dist: mkdocs>=1.5
|
|
29
30
|
Requires-Dist: mknodes
|
|
31
|
+
Requires-Dist: opentelemetry-instrumentation-jinja2
|
|
32
|
+
Requires-Dist: opentelemetry-instrumentation-urllib
|
|
33
|
+
Requires-Dist: opentelemetry-instrumentation-urllib3
|
|
30
34
|
Requires-Dist: pathspec
|
|
35
|
+
Requires-Dist: pydantic
|
|
31
36
|
Requires-Dist: rich
|
|
32
37
|
Requires-Dist: typer
|
|
33
38
|
Requires-Dist: universal-pathlib
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
INHERIT: mkdocs_shared.yml
|
|
2
|
+
|
|
3
|
+
site_name: MkDocs
|
|
4
|
+
site_description: A MkDocs page created by MkNodes
|
|
5
|
+
repo_url: "https://github.com/mkdocs/mkdocs/"
|
|
6
|
+
site_url: https://phil65.github.io/mknodes/mkdocs/
|
|
7
|
+
plugins:
|
|
8
|
+
- mknodes:
|
|
9
|
+
repo_path: https://github.com/mkdocs/mkdocs.git
|
|
10
|
+
clone_depth: 100
|
|
11
|
+
build_fn: mkdocs_mknodes:parse
|
|
12
|
+
kwargs:
|
|
13
|
+
pages:
|
|
14
|
+
- title: Home
|
|
15
|
+
type: MkText
|
|
16
|
+
text: "{{ metadata.description }}"
|
|
17
|
+
is_index: true
|
|
18
|
+
- Usage:
|
|
19
|
+
- type: MkTemplate
|
|
20
|
+
title: Getting started
|
|
21
|
+
template: https://raw.githubusercontent.com/mkdocs/mkdocs/master/docs/getting-started.md
|
|
22
|
+
- type: MkTemplate
|
|
23
|
+
title: Configuration
|
|
24
|
+
template: https://raw.githubusercontent.com/mkdocs/mkdocs/master/docs/user-guide/configuration.md
|
|
25
|
+
- type: MkTemplate
|
|
26
|
+
title: Deploying your docs
|
|
27
|
+
template: https://raw.githubusercontent.com/mkdocs/mkdocs/master/docs/user-guide/deploying-your-docs.md
|
|
28
|
+
- type: MkTemplate
|
|
29
|
+
title: Installation
|
|
30
|
+
template: https://raw.githubusercontent.com/mkdocs/mkdocs/master/docs/user-guide/installation.md
|
|
31
|
+
- title: API
|
|
32
|
+
type: MkDoc
|
|
33
|
+
section_name: "API"
|
|
34
|
+
recursive: true
|
|
35
|
+
- title: CLI
|
|
36
|
+
type: MkCliDoc
|
|
37
|
+
show_subcommands: true
|
|
38
|
+
condition: "{{ metadata.cli }}"
|
|
39
|
+
- Development:
|
|
40
|
+
- title: Changelog
|
|
41
|
+
type: MkChangelog
|
|
42
|
+
- title: Code of Conduct
|
|
43
|
+
type: MkCodeOfConduct
|
|
44
|
+
- title: Contributing
|
|
45
|
+
type: MkCommitConventions
|
|
46
|
+
- title: Pull requests
|
|
47
|
+
type: MkPullRequestGuidelines
|
|
48
|
+
- title: Dependencies
|
|
49
|
+
type: MkPage
|
|
50
|
+
items:
|
|
51
|
+
- title: Dependency table
|
|
52
|
+
type: MkDependencyTable
|
|
53
|
+
- title: Dependency tree
|
|
54
|
+
type: MkPipDepTree
|
|
55
|
+
direction: LR
|
|
56
|
+
- title: Dependencies
|
|
57
|
+
type: MkDependencyTable
|
|
58
|
+
- title: MkDocs Plugins
|
|
59
|
+
condition: '{{ "mkdocs.plugins" in metadata.entry_points }}'
|
|
60
|
+
type: MkPluginFlow
|
|
61
|
+
- title: License
|
|
62
|
+
type: MkLicense
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
__version__ = "0.5.0"
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
from .mkdefaultwebsite import MkDefaultWebsite
|
|
5
|
+
from . import telemetry
|
|
6
|
+
|
|
7
|
+
telemetry.setup_logfire()
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def parse(root, theme, pages):
|
|
11
|
+
from mknodes.navs.navparser import parse_new_style_nav
|
|
12
|
+
|
|
13
|
+
parse_new_style_nav(root, pages)
|
|
14
|
+
return root
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
__all__ = ["MkDefaultWebsite"]
|
|
@@ -8,17 +8,16 @@ from jinjarope import serializefilters
|
|
|
8
8
|
import markdown
|
|
9
9
|
from mkdocs.config import config_options
|
|
10
10
|
from mkdocs.config.defaults import MkDocsConfig
|
|
11
|
-
from mkdocs.plugins import get_plugin_logger
|
|
12
11
|
from mkdocs.structure import files as files_
|
|
13
12
|
from mknodes.utils import pathhelpers, resources
|
|
14
13
|
import upath
|
|
15
14
|
|
|
16
|
-
from mkdocs_mknodes import mkdocsconfig
|
|
15
|
+
from mkdocs_mknodes import mkdocsconfig, telemetry
|
|
17
16
|
from mkdocs_mknodes.backends import buildbackend
|
|
18
17
|
from mkdocs_mknodes.plugin import mkdocsbuilder, mkdocshelpers
|
|
19
18
|
|
|
20
19
|
|
|
21
|
-
logger = get_plugin_logger(__name__)
|
|
20
|
+
logger = telemetry.get_plugin_logger(__name__)
|
|
22
21
|
|
|
23
22
|
|
|
24
23
|
class MkDocsBackend(buildbackend.BuildBackend):
|
|
@@ -8,6 +8,7 @@ import pathlib
|
|
|
8
8
|
import pprint
|
|
9
9
|
from typing import TYPE_CHECKING
|
|
10
10
|
|
|
11
|
+
import logfire
|
|
11
12
|
import mknodes as mk
|
|
12
13
|
from mknodes.utils import log, resources
|
|
13
14
|
|
|
@@ -227,6 +228,7 @@ class BuildCollector:
|
|
|
227
228
|
templates=templates,
|
|
228
229
|
)
|
|
229
230
|
|
|
231
|
+
@logfire.instrument("collect_page: {page.title}")
|
|
230
232
|
def collect_page(self, page: mk.MkPage):
|
|
231
233
|
"""Preprocess page and collect its data.
|
|
232
234
|
|
|
@@ -245,6 +247,7 @@ class BuildCollector:
|
|
|
245
247
|
if show_info:
|
|
246
248
|
add_page_info(page, req)
|
|
247
249
|
|
|
250
|
+
@logfire.instrument("render_page: {page.title}")
|
|
248
251
|
def render_page(self, page: mk.MkPage):
|
|
249
252
|
"""Convert a page to markdown/HTML.
|
|
250
253
|
|
|
@@ -260,6 +263,7 @@ class BuildCollector:
|
|
|
260
263
|
|
|
261
264
|
self.node_files[page.resolved_file_path] = md
|
|
262
265
|
|
|
266
|
+
@logfire.instrument("collect_nav: {nav.title}")
|
|
263
267
|
def collect_nav(self, nav: mk.MkNav):
|
|
264
268
|
"""Preprocess nav and collect its data.
|
|
265
269
|
|
|
@@ -273,6 +277,7 @@ class BuildCollector:
|
|
|
273
277
|
self.resources.merge(req)
|
|
274
278
|
update_nav_template(nav)
|
|
275
279
|
|
|
280
|
+
@logfire.instrument("render_nav: {nav.title}")
|
|
276
281
|
def render_nav(self, nav: mk.MkNav):
|
|
277
282
|
"""Convert a nav to markdown/HTML.
|
|
278
283
|
|
|
@@ -53,15 +53,13 @@ VERBOSE_CMDS = "-v", "--verbose"
|
|
|
53
53
|
QUIET_CMDS = "-q", "--quiet"
|
|
54
54
|
|
|
55
55
|
|
|
56
|
-
def verbose(ctx: t.Context,
|
|
57
|
-
# sourcery skip: move-assign
|
|
56
|
+
def verbose(ctx: t.Context, _param: t.CallbackParam, value: bool):
|
|
58
57
|
state = ctx.ensure_object(richstate.RichState)
|
|
59
58
|
if value:
|
|
60
59
|
state.stream.setLevel(logging.DEBUG)
|
|
61
60
|
|
|
62
61
|
|
|
63
|
-
def quiet(ctx: t.Context,
|
|
64
|
-
# sourcery skip: move-assign
|
|
62
|
+
def quiet(ctx: t.Context, _param: t.CallbackParam, value: bool):
|
|
65
63
|
state = ctx.ensure_object(richstate.RichState)
|
|
66
64
|
if value:
|
|
67
65
|
state.stream.setLevel(logging.ERROR)
|