mkdocs-mknodes 0.5.1__tar.gz → 0.5.2__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.5.2/.github/copilot-instructions.md +20 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/PKG-INFO +2 -2
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/__init__.py +1 -1
- mkdocs_mknodes-0.5.2/mkdocs_mknodes/appconfig/appconfig.py +241 -0
- mkdocs_mknodes-0.5.2/mkdocs_mknodes/builders/configbuilder.py +52 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/cli/__init__.py +3 -2
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/commands/build_page.py +17 -32
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/commands/serve.py +4 -3
- mkdocs_mknodes-0.5.2/mkdocs_mknodes/py.typed +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/pyproject.toml +3 -1
- mkdocs_mknodes-0.5.2/tests/__init__.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/.editorconfig +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/.github/README.md +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/.github/dependabot.yml +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/.github/workflows/build.yml +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/.github/workflows/documentation.yml +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/.gitignore +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/.pre-commit-config.yaml +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/LICENSE +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/README.md +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/configs/mkdocs_mkdocs.yml +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/configs/mkdocs_shared.yml +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/docs/assets/cli.gif +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/docs/build_process.jinja +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/docs/cli_index.jinja +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/docs/github_index.jinja +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/docs/index.jinja +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/docs/plugin_configuration.jinja +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/docs/use_case_by_config.jinja +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/docs/use_case_default_website.jinja +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/docs/use_cases_index.jinja +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/docs/why_should_i_use_mknodes.jinja +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/duties.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs.yml +0 -0
- {mkdocs_mknodes-0.5.1/mkdocs_mknodes/commands → mkdocs_mknodes-0.5.2/mkdocs_mknodes/appconfig}/__init__.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/backends/__init__.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/backends/buildbackend.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/backends/markdownbackend.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/backends/mkdocsbackend.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/buildcollector.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/buildcontext.py +0 -0
- {mkdocs_mknodes-0.5.1/tests → mkdocs_mknodes-0.5.2/mkdocs_mknodes/builders}/__init__.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/cli/richstate.py +0 -0
- /mkdocs_mknodes-0.5.1/mkdocs_mknodes/py.typed → /mkdocs_mknodes-0.5.2/mkdocs_mknodes/commands/__init__.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/commands/utils.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/liveserver.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/manual/__init__.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/manual/cli_section.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/manual/get_started_section.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/manual/github_index.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/manual/root.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/manual/use_cases_section.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/mkdefaultwebsite.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/mkdocsconfig.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/mknodesconfig.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/paths.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/plugin/__init__.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/plugin/mkdocsbuilder.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/plugin/pluginconfig.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes/telemetry.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/mkdocs_mknodes.sublime-project +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/overrides/_dummy.txt +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/overrides/partials/actions.html +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/tests/conftest.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/tests/data/objects.inv +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/tests/test_build.py +0 -0
- {mkdocs_mknodes-0.5.1 → mkdocs_mknodes-0.5.2}/tests/test_cli.py +0 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
## Code style
|
|
2
|
+
|
|
3
|
+
You can assume Python 3.12.
|
|
4
|
+
Use newest language features if possible
|
|
5
|
+
Adhere to pep8.
|
|
6
|
+
Consider using pattern matching and walrus operators.
|
|
7
|
+
|
|
8
|
+
## Tests
|
|
9
|
+
|
|
10
|
+
Tests are written using PyTest.
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## DocStrings
|
|
14
|
+
|
|
15
|
+
DocStrings are written in google-style.
|
|
16
|
+
Dont add the types to the Args section.
|
|
17
|
+
Only add a Return section if a value is returned and the meaning of the returned value
|
|
18
|
+
is not obvious.
|
|
19
|
+
You can use markdown admonitions with python-markdown syntax (!!! info, !!! note, !!! warning)
|
|
20
|
+
You can use markdown tables and markdown lists if neccessary.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.3
|
|
2
2
|
Name: mkdocs-mknodes
|
|
3
|
-
Version: 0.5.
|
|
3
|
+
Version: 0.5.2
|
|
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
|
|
@@ -24,7 +24,7 @@ Classifier: Topic :: Software Development :: User Interfaces
|
|
|
24
24
|
Classifier: Topic :: Text Processing :: Markup :: Markdown
|
|
25
25
|
Requires-Python: >=3.12
|
|
26
26
|
Requires-Dist: jinja2
|
|
27
|
-
Requires-Dist: jinjarope
|
|
27
|
+
Requires-Dist: jinjarope[yaml]
|
|
28
28
|
Requires-Dist: logfire[aiohttp,requests,system-metrics]
|
|
29
29
|
Requires-Dist: mkdocs>=1.5
|
|
30
30
|
Requires-Dist: mknodes
|
|
@@ -0,0 +1,241 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import ipaddress
|
|
4
|
+
from typing import Annotated, Any
|
|
5
|
+
|
|
6
|
+
from pathspec import gitignore
|
|
7
|
+
from pydantic import BaseModel, DirectoryPath, Field, FilePath, HttpUrl, field_validator
|
|
8
|
+
from pydantic.functional_validators import BeforeValidator
|
|
9
|
+
from pydantic_core import PydanticCustomError
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
def validate_gitignore_patterns(patterns: list[str]) -> list[str]:
|
|
13
|
+
"""Validate a list of gitignore patterns using pathspec."""
|
|
14
|
+
try:
|
|
15
|
+
gitignore.GitIgnoreSpec.from_lines(patterns)
|
|
16
|
+
except Exception as e:
|
|
17
|
+
msg = "invalid_gitignore_pattern"
|
|
18
|
+
raise PydanticCustomError(
|
|
19
|
+
msg,
|
|
20
|
+
"Invalid gitignore pattern(s): {error}",
|
|
21
|
+
{"error": str(e)},
|
|
22
|
+
) from e
|
|
23
|
+
else:
|
|
24
|
+
return patterns
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
GitIgnorePatterns = Annotated[
|
|
28
|
+
list[str],
|
|
29
|
+
BeforeValidator(validate_gitignore_patterns),
|
|
30
|
+
]
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
class NavItem(BaseModel):
|
|
34
|
+
"""Represents a navigation item in the MkDocs configuration.
|
|
35
|
+
|
|
36
|
+
Can be a string (for a simple link) or a dict (for nested navigation).
|
|
37
|
+
"""
|
|
38
|
+
|
|
39
|
+
item: str | dict[str, NavItem]
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
class ThemeConfig(BaseModel):
|
|
43
|
+
"""Configuration for the MkDocs theme."""
|
|
44
|
+
|
|
45
|
+
class Config:
|
|
46
|
+
extra = "allow"
|
|
47
|
+
populate_by_name = True
|
|
48
|
+
|
|
49
|
+
name: str = Field(..., description="The name of the theme to use.")
|
|
50
|
+
custom_dir: DirectoryPath | None = Field(
|
|
51
|
+
None, description="Directory containing a custom theme."
|
|
52
|
+
)
|
|
53
|
+
static_templates: list[str] | None = Field(
|
|
54
|
+
None, description="List of templates to render as static pages."
|
|
55
|
+
)
|
|
56
|
+
locale: str | None = Field(
|
|
57
|
+
None, description="The locale to use for the theme (e.g., 'en' or 'fr')."
|
|
58
|
+
)
|
|
59
|
+
# Material-related
|
|
60
|
+
# palette: dict[str, Any] | None = Field(
|
|
61
|
+
# None, description="Color palette configuration for the theme."
|
|
62
|
+
# )
|
|
63
|
+
# font: dict[str, Any] | None = Field(
|
|
64
|
+
# None, description="Font configuration for the theme."
|
|
65
|
+
# )
|
|
66
|
+
# features: list[str] | None = Field(
|
|
67
|
+
# None, description="List of theme-specific features to enable."
|
|
68
|
+
# )
|
|
69
|
+
# logo: str | None = Field(None, description="Path to a logo file for the theme.")
|
|
70
|
+
# icon: str | None = Field(None, description="Path to a favicon file.")
|
|
71
|
+
# favicon: str | None = Field(None, description="Path to a favicon file.")
|
|
72
|
+
# language: str | None = Field(None, description="Language for theme localization.")
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
class PluginConfig(BaseModel):
|
|
76
|
+
"""Configuration for a MkDocs plugin."""
|
|
77
|
+
|
|
78
|
+
name: str = Field(..., description="The name of the plugin.")
|
|
79
|
+
config: dict[str, Any] | None = Field(
|
|
80
|
+
None, description="Plugin-specific configuration options."
|
|
81
|
+
)
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
class AppConfig(BaseModel):
|
|
85
|
+
"""Represents the full configuration for a MkDocs project."""
|
|
86
|
+
|
|
87
|
+
config_file_path: str | None = Field(None, description="Path to the config file.")
|
|
88
|
+
|
|
89
|
+
# Site information
|
|
90
|
+
site_name: str = Field(..., description="The name of the project documentation.")
|
|
91
|
+
site_url: HttpUrl | None = Field(
|
|
92
|
+
None, description="The URL where the documentation will be hosted."
|
|
93
|
+
)
|
|
94
|
+
site_description: str | None = Field(
|
|
95
|
+
None, description="A description of the documentation project."
|
|
96
|
+
)
|
|
97
|
+
site_author: str | None = Field(None, description="The author of the documentation.")
|
|
98
|
+
copyright: str | None = Field(
|
|
99
|
+
None, description="A copyright statement for the documentation."
|
|
100
|
+
)
|
|
101
|
+
|
|
102
|
+
# Repository information
|
|
103
|
+
repo_name: str | None = Field(None, description="The name of the source repository.")
|
|
104
|
+
repo_url: HttpUrl | None = Field(
|
|
105
|
+
None, description="The URL of the source repository."
|
|
106
|
+
)
|
|
107
|
+
edit_uri: str | None = Field(
|
|
108
|
+
None, description="Path to the docs directory in the source repository."
|
|
109
|
+
)
|
|
110
|
+
remote_branch: str | None = Field(
|
|
111
|
+
None, description="The remote branch to point to (default: 'master')."
|
|
112
|
+
)
|
|
113
|
+
remote_name: str | None = Field(
|
|
114
|
+
None, description="The remote name to push to (default: 'origin')."
|
|
115
|
+
)
|
|
116
|
+
|
|
117
|
+
# Configuration directories
|
|
118
|
+
docs_dir: DirectoryPath = Field(
|
|
119
|
+
"docs", description="The directory containing the documentation source files."
|
|
120
|
+
)
|
|
121
|
+
site_dir: DirectoryPath = Field(
|
|
122
|
+
"site", description="The directory where the output HTML will be created."
|
|
123
|
+
)
|
|
124
|
+
extra_templates: list[DirectoryPath] | None = Field(
|
|
125
|
+
None, description="List of directories containing extra Jinja2 templates."
|
|
126
|
+
)
|
|
127
|
+
|
|
128
|
+
# Theme configuration
|
|
129
|
+
theme: ThemeConfig = Field(
|
|
130
|
+
..., description="The theme configuration for the documentation."
|
|
131
|
+
)
|
|
132
|
+
|
|
133
|
+
# Build configuration
|
|
134
|
+
use_directory_urls: bool = Field(
|
|
135
|
+
True, description="Use directory URLs when building pages (default: True)."
|
|
136
|
+
)
|
|
137
|
+
strict: bool = Field(
|
|
138
|
+
False, description="Enable strict mode for warnings as errors (default: False)."
|
|
139
|
+
)
|
|
140
|
+
dev_addr: str = Field(
|
|
141
|
+
"127.0.0.1:8000", description="The server address for the development server."
|
|
142
|
+
)
|
|
143
|
+
extra_css: list[FilePath] | None = Field(
|
|
144
|
+
None, description="List of CSS files to include in the documentation."
|
|
145
|
+
)
|
|
146
|
+
extra_javascript: list[FilePath] | None = Field(
|
|
147
|
+
None, description="List of JavaScript files to include in the documentation."
|
|
148
|
+
)
|
|
149
|
+
|
|
150
|
+
# Markdown extensions
|
|
151
|
+
markdown_extensions: list[str | dict[str, Any]] | None = Field(
|
|
152
|
+
None, description="List of Markdown extensions to use."
|
|
153
|
+
)
|
|
154
|
+
hooks: list[str] | None = Field(
|
|
155
|
+
None, description="List of Python scripts to load as hooks."
|
|
156
|
+
)
|
|
157
|
+
|
|
158
|
+
# Navigation
|
|
159
|
+
nav: list[NavItem] | None = Field(
|
|
160
|
+
None, description="The navigation structure for the documentation."
|
|
161
|
+
)
|
|
162
|
+
|
|
163
|
+
# Plugins
|
|
164
|
+
plugins: list[dict[str, Any]] = Field(
|
|
165
|
+
default_factory=list, description="List of plugins to use."
|
|
166
|
+
)
|
|
167
|
+
|
|
168
|
+
# Internationalization
|
|
169
|
+
language: str | None = Field(
|
|
170
|
+
None, description="The language of the documentation (as a BCP 47 language tag)."
|
|
171
|
+
)
|
|
172
|
+
locale: str | None = Field(
|
|
173
|
+
None, description="The locale of the documentation (e.g., 'en_US')."
|
|
174
|
+
)
|
|
175
|
+
|
|
176
|
+
# Additional options
|
|
177
|
+
extra: dict[str, Any] | None = Field(
|
|
178
|
+
None, description="A set of key-value pairs for custom data in templates."
|
|
179
|
+
)
|
|
180
|
+
validation: dict[str, Any] | None = Field(
|
|
181
|
+
None, description="Validation options for external links and fragments."
|
|
182
|
+
)
|
|
183
|
+
watch: list[DirectoryPath] | None = Field(
|
|
184
|
+
None, description="List of directories to watch for changes."
|
|
185
|
+
)
|
|
186
|
+
exclude_docs: GitIgnorePatterns = Field(
|
|
187
|
+
default_factory=list,
|
|
188
|
+
description="Gitignore-like file patterns to exclude pages from the site.",
|
|
189
|
+
)
|
|
190
|
+
|
|
191
|
+
not_in_nav: GitIgnorePatterns = Field(
|
|
192
|
+
default_factory=list,
|
|
193
|
+
description="Gitignore-like file patterns to exclude pages from nav.",
|
|
194
|
+
)
|
|
195
|
+
|
|
196
|
+
@field_validator("plugins", mode="before")
|
|
197
|
+
@classmethod
|
|
198
|
+
def convert_to_plugin_dict_list(
|
|
199
|
+
cls,
|
|
200
|
+
value: list[str | dict[str, dict[str, Any]]] | dict[str, Any],
|
|
201
|
+
) -> list[dict[str, dict[str, Any]]]:
|
|
202
|
+
result: list[dict[str, Any]] = []
|
|
203
|
+
for item in value:
|
|
204
|
+
if isinstance(item, str):
|
|
205
|
+
result.append({item: {}})
|
|
206
|
+
elif isinstance(item, dict):
|
|
207
|
+
if len(item) > 1:
|
|
208
|
+
msg = "Plugin dictionaries must have a single key"
|
|
209
|
+
raise ValueError(msg)
|
|
210
|
+
result.append(item)
|
|
211
|
+
else:
|
|
212
|
+
msg = f"Invalid type for plugin section: {item!r} ({type(item)})"
|
|
213
|
+
raise ValueError(msg) # noqa: TRY004
|
|
214
|
+
return result
|
|
215
|
+
|
|
216
|
+
@field_validator("dev_addr", mode="before")
|
|
217
|
+
@classmethod
|
|
218
|
+
def validate_ip_port(cls, v: str) -> str:
|
|
219
|
+
try:
|
|
220
|
+
ip, port = v.split(":")
|
|
221
|
+
ipaddress.ip_address(ip) # Validates IP
|
|
222
|
+
except ValueError as e:
|
|
223
|
+
msg = f"Invalid IP:PORT format - {e!s}"
|
|
224
|
+
raise ValueError(msg) from e
|
|
225
|
+
if not 1 <= int(port) <= 65535: # noqa: PLR2004
|
|
226
|
+
msg = "Port must be between 1 and 65535"
|
|
227
|
+
raise ValueError(msg)
|
|
228
|
+
return v
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
if __name__ == "__main__":
|
|
232
|
+
import pathlib
|
|
233
|
+
|
|
234
|
+
import devtools
|
|
235
|
+
import yaml
|
|
236
|
+
|
|
237
|
+
text = pathlib.Path("mkdocs.yml").read_text()
|
|
238
|
+
cfg = yaml.unsafe_load(text)
|
|
239
|
+
config = AppConfig(**cfg)
|
|
240
|
+
|
|
241
|
+
devtools.debug(config)
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import io
|
|
4
|
+
import os
|
|
5
|
+
from typing import Any
|
|
6
|
+
|
|
7
|
+
from jinjarope import yamltools
|
|
8
|
+
from mkdocs.config import load_config
|
|
9
|
+
from mkdocs.config.defaults import MkDocsConfig
|
|
10
|
+
from mknodes.info import mkdocsconfigfile
|
|
11
|
+
|
|
12
|
+
from mkdocs_mknodes import telemetry
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
logger = telemetry.get_plugin_logger(__name__)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class ConfigBuilder:
|
|
19
|
+
def __init__(
|
|
20
|
+
self,
|
|
21
|
+
configs: list[mkdocsconfigfile.MkDocsConfigFile] | None = None,
|
|
22
|
+
repo_path: str | None = ".",
|
|
23
|
+
build_fn: str | None = None,
|
|
24
|
+
clone_depth: int | None = 100,
|
|
25
|
+
):
|
|
26
|
+
self.configs = configs or []
|
|
27
|
+
self.repo_path = repo_path
|
|
28
|
+
self.build_fn = build_fn
|
|
29
|
+
self.clone_depth = clone_depth
|
|
30
|
+
|
|
31
|
+
def add_config_file(self, path: str | os.PathLike[str]):
|
|
32
|
+
cfg = mkdocsconfigfile.MkDocsConfigFile(path)
|
|
33
|
+
self.configs.append(cfg)
|
|
34
|
+
|
|
35
|
+
def build_mkdocs_config(self, **kwargs: Any) -> MkDocsConfig:
|
|
36
|
+
cfg = self.configs[0]
|
|
37
|
+
cfg = {**cfg, **kwargs}
|
|
38
|
+
text = yamltools.dump_yaml(cfg)
|
|
39
|
+
buffer = io.StringIO(text)
|
|
40
|
+
buffer.name = self.configs[0].path
|
|
41
|
+
config = load_config(buffer, **kwargs)
|
|
42
|
+
for plugin in config["plugins"]:
|
|
43
|
+
if "mknodes" in plugin:
|
|
44
|
+
if self.repo_path is not None:
|
|
45
|
+
plugin["mknodes"]["repo_path"] = self.repo_path
|
|
46
|
+
if self.build_fn is not None:
|
|
47
|
+
plugin["mknodes"]["build_fn"] = self.build_fn
|
|
48
|
+
if self.clone_depth is not None:
|
|
49
|
+
plugin["mknodes"]["clone_depth"] = self.clone_depth
|
|
50
|
+
for k, v in config.items():
|
|
51
|
+
logger.debug("%s: %s", k, v)
|
|
52
|
+
return config
|
|
@@ -8,7 +8,8 @@ from mknodes.info.mkdocsconfigfile import MkDocsConfigFile
|
|
|
8
8
|
|
|
9
9
|
import typer as t
|
|
10
10
|
|
|
11
|
-
from
|
|
11
|
+
from jinjarope import yamltools
|
|
12
|
+
from mknodes.utils import classhelpers, log
|
|
12
13
|
import mknodes as mk
|
|
13
14
|
|
|
14
15
|
from mkdocs_mknodes import buildcollector, paths
|
|
@@ -170,7 +171,7 @@ def create_config(
|
|
|
170
171
|
config["site_name"] = info.distribution_name
|
|
171
172
|
config["site_author"] = info.author_name
|
|
172
173
|
config["copyright"] = f"Copyright © {datetime.now().year} {info.author_name}"
|
|
173
|
-
result =
|
|
174
|
+
result = yamltools.dump_yaml(config)
|
|
174
175
|
print(result)
|
|
175
176
|
|
|
176
177
|
|
|
@@ -4,7 +4,6 @@ from __future__ import annotations
|
|
|
4
4
|
|
|
5
5
|
from collections.abc import Collection, Sequence
|
|
6
6
|
from datetime import UTC, datetime
|
|
7
|
-
import io
|
|
8
7
|
import os
|
|
9
8
|
from typing import TYPE_CHECKING, Any
|
|
10
9
|
from urllib.parse import urljoin, urlsplit
|
|
@@ -15,15 +14,15 @@ from jinjarope import envtests, htmlfilters
|
|
|
15
14
|
import logfire
|
|
16
15
|
from mkdocs import exceptions
|
|
17
16
|
from mkdocs.commands import build as mkdocs_build
|
|
18
|
-
from mkdocs.config import load_config
|
|
19
17
|
from mkdocs.structure.files import InclusionLevel
|
|
20
18
|
from mkdocs.structure.nav import Navigation, get_navigation
|
|
21
19
|
from mkdocs.structure.pages import Page
|
|
22
20
|
from mknodes.info import mkdocsconfigfile
|
|
23
|
-
from mknodes.utils import pathhelpers
|
|
21
|
+
from mknodes.utils import pathhelpers
|
|
24
22
|
import upath
|
|
25
23
|
|
|
26
24
|
from mkdocs_mknodes import telemetry
|
|
25
|
+
from mkdocs_mknodes.builders import configbuilder
|
|
27
26
|
from mkdocs_mknodes.commands import utils
|
|
28
27
|
|
|
29
28
|
|
|
@@ -61,30 +60,16 @@ def build(
|
|
|
61
60
|
clone_depth: Number of commits to fetch for Git repos
|
|
62
61
|
kwargs: Additional config overrides passed to MkDocs
|
|
63
62
|
"""
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
build_fn=build_fn,
|
|
70
|
-
clone_depth=clone_depth,
|
|
71
|
-
)
|
|
72
|
-
if site_dir:
|
|
73
|
-
cfg["site_dir"] = site_dir
|
|
74
|
-
text = yamlhelpers.dump_yaml(dict(cfg))
|
|
75
|
-
buffer = io.StringIO(text)
|
|
76
|
-
buffer.name = config_path
|
|
77
|
-
config = load_config(buffer, **kwargs)
|
|
78
|
-
for k, v in config.items():
|
|
79
|
-
logger.debug("%s: %s", k, v)
|
|
80
|
-
return config
|
|
81
|
-
|
|
82
|
-
config = build_config()
|
|
63
|
+
cfg_builder = configbuilder.ConfigBuilder(
|
|
64
|
+
repo_path=repo_path, build_fn=build_fn, clone_depth=clone_depth
|
|
65
|
+
)
|
|
66
|
+
cfg_builder.add_config_file(config_path)
|
|
67
|
+
config = cfg_builder.build_mkdocs_config(site_dir=site_dir, **kwargs)
|
|
83
68
|
with logfire.span("plugins callback: on_startup", config=config):
|
|
84
|
-
config.plugins.
|
|
69
|
+
config.plugins.on_startup(command="build", dirty=False)
|
|
85
70
|
_build(config)
|
|
86
71
|
with logfire.span("plugins callback: shutdown", config=config):
|
|
87
|
-
config.plugins.
|
|
72
|
+
config.plugins.on_shutdown()
|
|
88
73
|
|
|
89
74
|
|
|
90
75
|
@utils.handle_exceptions
|
|
@@ -104,9 +89,6 @@ def _build(
|
|
|
104
89
|
live_server_url: An optional URL of the live server to use
|
|
105
90
|
dirty: Do a dirty build
|
|
106
91
|
"""
|
|
107
|
-
inclusion = (
|
|
108
|
-
InclusionLevel.is_in_serve if live_server_url else InclusionLevel.is_included
|
|
109
|
-
)
|
|
110
92
|
with logfire.span("plugins callback: on_config", config=config):
|
|
111
93
|
config = config.plugins.on_config(config)
|
|
112
94
|
with logfire.span("plugins callback: on_pre_build", config=config):
|
|
@@ -136,6 +118,9 @@ def _build(
|
|
|
136
118
|
nav = config.plugins.on_nav(nav, config=config, files=files)
|
|
137
119
|
logger.debug("Reading markdown pages.")
|
|
138
120
|
excluded: list[str] = []
|
|
121
|
+
inclusion = (
|
|
122
|
+
InclusionLevel.is_in_serve if live_server_url else InclusionLevel.is_included
|
|
123
|
+
)
|
|
139
124
|
with logfire.span("populate pages"):
|
|
140
125
|
for file in files.documentation_pages(inclusion=inclusion):
|
|
141
126
|
with logfire.span(f"populate page for {file.src_uri}", file=file):
|
|
@@ -316,7 +301,7 @@ def _build_theme_template(
|
|
|
316
301
|
try:
|
|
317
302
|
template = env.get_template(template_name)
|
|
318
303
|
except TemplateNotFound:
|
|
319
|
-
logger.warning("Template skipped:
|
|
304
|
+
logger.warning("Template skipped: %r not found in theme dirs.", template_name)
|
|
320
305
|
return
|
|
321
306
|
|
|
322
307
|
output = _build_template(template_name, template, files, config, nav)
|
|
@@ -329,7 +314,7 @@ def _build_theme_template(
|
|
|
329
314
|
ts = get_build_timestamp(pages=[f.page for f in docs if f.page is not None])
|
|
330
315
|
utils.write_gzip(f"{output_path}.gz", output, timestamp=ts)
|
|
331
316
|
else:
|
|
332
|
-
logger.info("Template skipped:
|
|
317
|
+
logger.info("Template skipped: %r generated empty output.", template_name)
|
|
333
318
|
|
|
334
319
|
|
|
335
320
|
def _build_extra_template(
|
|
@@ -340,18 +325,18 @@ def _build_extra_template(
|
|
|
340
325
|
|
|
341
326
|
file = files.get_file_from_path(template_name)
|
|
342
327
|
if file is None:
|
|
343
|
-
logger.warning("Template skipped:
|
|
328
|
+
logger.warning("Template skipped: %r not found in docs_dir.", template_name)
|
|
344
329
|
return
|
|
345
330
|
try:
|
|
346
331
|
template = jinja2.Template(file.content_string)
|
|
347
332
|
except Exception as e: # noqa: BLE001
|
|
348
|
-
logger.warning("Error reading template
|
|
333
|
+
logger.warning("Error reading template %r: %s", template_name, e)
|
|
349
334
|
return
|
|
350
335
|
output = _build_template(template_name, template, files, config, nav)
|
|
351
336
|
if output.strip():
|
|
352
337
|
pathhelpers.write_file(output.encode(), file.abs_dest_path)
|
|
353
338
|
else:
|
|
354
|
-
logger.info("Template skipped:
|
|
339
|
+
logger.info("Template skipped: %r generated empty output.", template_name)
|
|
355
340
|
|
|
356
341
|
|
|
357
342
|
def get_build_timestamp(*, pages: Collection[Page] | None = None) -> int:
|
|
@@ -10,9 +10,10 @@ from typing import TYPE_CHECKING, Any, Literal
|
|
|
10
10
|
from urllib.parse import urlsplit
|
|
11
11
|
|
|
12
12
|
# from mkdocs.commands import serve as serve_
|
|
13
|
+
from jinjarope import yamltools
|
|
13
14
|
from mkdocs.config import load_config
|
|
14
15
|
from mknodes.info import mkdocsconfigfile
|
|
15
|
-
from mknodes.utils import log
|
|
16
|
+
from mknodes.utils import log
|
|
16
17
|
|
|
17
18
|
from mkdocs_mknodes import liveserver, paths
|
|
18
19
|
from mkdocs_mknodes.commands import build_page
|
|
@@ -52,7 +53,7 @@ def serve(
|
|
|
52
53
|
config.remove_plugin("social")
|
|
53
54
|
config.remove_plugin("tags")
|
|
54
55
|
kwargs["theme"] = theme
|
|
55
|
-
text =
|
|
56
|
+
text = yamltools.dump_yaml(dict(config))
|
|
56
57
|
stream = io.StringIO(text)
|
|
57
58
|
stream.name = str(config_path)
|
|
58
59
|
_serve(config_file=stream, livereload=False, **kwargs) # type: ignore[arg-type]
|
|
@@ -94,7 +95,7 @@ def _serve(
|
|
|
94
95
|
build_type: Literal["clean", "dirty"] | None = None,
|
|
95
96
|
watch_theme: bool = False,
|
|
96
97
|
watch: list[str] | None = None,
|
|
97
|
-
**kwargs,
|
|
98
|
+
**kwargs: Any,
|
|
98
99
|
) -> None:
|
|
99
100
|
"""Start the MkDocs development server.
|
|
100
101
|
|
|
File without changes
|
|
@@ -41,7 +41,7 @@ dependencies = [
|
|
|
41
41
|
"typer",
|
|
42
42
|
# Tools
|
|
43
43
|
"jinja2",
|
|
44
|
-
"jinjarope",
|
|
44
|
+
"jinjarope[yaml]",
|
|
45
45
|
"universal_pathlib",
|
|
46
46
|
"pydantic",
|
|
47
47
|
"logfire[requests,aiohttp,system-metrics]",
|
|
@@ -88,6 +88,7 @@ dev-dependencies = [
|
|
|
88
88
|
# dev
|
|
89
89
|
"pyreadline3",
|
|
90
90
|
"pyinstrument",
|
|
91
|
+
"devtools",
|
|
91
92
|
# used for formatting signature
|
|
92
93
|
"black",
|
|
93
94
|
"pygments",
|
|
@@ -243,6 +244,7 @@ reportUnknownVariableType = false
|
|
|
243
244
|
reportImplicitOverride = false
|
|
244
245
|
reportAny = false
|
|
245
246
|
pythonVersion = "3.12"
|
|
247
|
+
reportUnannotatedClassAttribute = false
|
|
246
248
|
|
|
247
249
|
[tool.mknodes]
|
|
248
250
|
allowed-commit-types = [
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|