mkdocs-mknodes 0.7.4__tar.gz → 0.7.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.
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/PKG-INFO +11 -8
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/README.md +58 -58
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/__init__.py +17 -17
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/appconfig/appconfig.py +822 -826
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/appconfig/base.py +67 -64
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/appconfig/jinjaconfig.py +60 -60
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/appconfig/themeconfig.py +177 -179
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/appconfig/upathtype.py +185 -178
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/appconfig/validationconfig.py +41 -41
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/backends/__init__.py +1 -1
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/backends/buildbackend.py +56 -50
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/backends/markdownbackend.py +48 -43
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/backends/mkdocsbackend.py +167 -162
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/buildcollector.py +298 -301
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/buildcontext.py +47 -43
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/builders/configbuilder.py +59 -56
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/cli/__init__.py +176 -180
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/cli/richstate.py +34 -34
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/commands/build_page.py +413 -420
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/commands/serve.py +187 -187
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/commands/utils.py +210 -213
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/liveserver.py +374 -379
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/manual/__init__.py +1 -1
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/manual/cli_section.py +28 -28
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/manual/get_started_section.py +49 -49
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/manual/github_index.py +17 -17
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/manual/root.py +30 -30
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/manual/use_cases_section.py +19 -19
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/mkdefaultwebsite.py +53 -54
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/mkdocsconfig.py +253 -248
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/paths.py +11 -11
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/plugin/__init__.py +223 -222
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/plugin/mkdocsbuilder.py +138 -141
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/plugin/mkdocshelpers.py +29 -25
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/plugin/mknodesconfig.py +346 -342
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/plugin/pluginconfig.py +147 -144
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/plugin/rewriteloader.py +56 -56
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/resources/timeline_data.toml +135 -135
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/telemetry.py +96 -93
- mkdocs_mknodes-0.7.7/pyproject.toml +282 -0
- mkdocs_mknodes-0.7.4/.editorconfig +0 -11
- mkdocs_mknodes-0.7.4/.github/README.md +0 -215
- mkdocs_mknodes-0.7.4/.github/copilot-instructions.md +0 -20
- mkdocs_mknodes-0.7.4/.github/dependabot.yml +0 -10
- mkdocs_mknodes-0.7.4/.github/workflows/build.yml +0 -85
- mkdocs_mknodes-0.7.4/.github/workflows/documentation.yml +0 -68
- mkdocs_mknodes-0.7.4/.gitignore +0 -54
- mkdocs_mknodes-0.7.4/.logfire/.gitignore +0 -1
- mkdocs_mknodes-0.7.4/.logfire/logfire_credentials.json +0 -6
- mkdocs_mknodes-0.7.4/.pre-commit-config.yaml +0 -49
- mkdocs_mknodes-0.7.4/LICENSE +0 -22
- mkdocs_mknodes-0.7.4/configs/mkdocs_mkdocs.yml +0 -62
- mkdocs_mknodes-0.7.4/configs/mkdocs_shared.yml +0 -32
- mkdocs_mknodes-0.7.4/docs/assets/cli.gif +0 -0
- mkdocs_mknodes-0.7.4/docs/build_process.jinja +0 -35
- mkdocs_mknodes-0.7.4/docs/cli_index.jinja +0 -18
- mkdocs_mknodes-0.7.4/docs/github_index.jinja +0 -13
- mkdocs_mknodes-0.7.4/docs/index.jinja +0 -28
- mkdocs_mknodes-0.7.4/docs/plugin_configuration.jinja +0 -2
- mkdocs_mknodes-0.7.4/docs/use_case_by_config.jinja +0 -19
- mkdocs_mknodes-0.7.4/docs/use_case_default_website.jinja +0 -18
- mkdocs_mknodes-0.7.4/docs/use_cases_index.jinja +0 -45
- mkdocs_mknodes-0.7.4/docs/why_should_i_use_mknodes.jinja +0 -44
- mkdocs_mknodes-0.7.4/duties.py +0 -68
- mkdocs_mknodes-0.7.4/mkdocs.yml +0 -105
- mkdocs_mknodes-0.7.4/mkdocs_mknodes/builders/markdownbuilder.py +0 -247
- mkdocs_mknodes-0.7.4/mkdocs_mknodes.sublime-project +0 -8
- mkdocs_mknodes-0.7.4/overrides/_dummy.txt +0 -1
- mkdocs_mknodes-0.7.4/overrides/partials/actions.html +0 -65
- mkdocs_mknodes-0.7.4/pyproject.toml +0 -265
- mkdocs_mknodes-0.7.4/tests/__init__.py +0 -0
- mkdocs_mknodes-0.7.4/tests/conftest.py +0 -10
- mkdocs_mknodes-0.7.4/tests/data/objects.inv +0 -0
- mkdocs_mknodes-0.7.4/tests/test_build.py +0 -60
- mkdocs_mknodes-0.7.4/tests/test_cli.py +0 -67
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/appconfig/__init__.py +0 -0
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/builders/__init__.py +0 -0
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/commands/__init__.py +0 -0
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/py.typed +0 -0
- {mkdocs_mknodes-0.7.4 → mkdocs_mknodes-0.7.7}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
|
@@ -1,30 +1,28 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: mkdocs-mknodes
|
|
3
|
-
Version: 0.7.
|
|
3
|
+
Version: 0.7.7
|
|
4
4
|
Summary: Don't write docs. Code them.
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
Project-URL: Gitter, https://app.gitter.im/#/room/#mknodes:gitter.im
|
|
5
|
+
Keywords: docs,docstrings,documentation,framework,internet,markdown
|
|
6
|
+
Author: Philipp Temminghoff
|
|
8
7
|
Author-email: Philipp Temminghoff <philipptemminghoff@gmail.com>
|
|
9
8
|
License-Expression: MIT
|
|
10
|
-
License-File: LICENSE
|
|
11
|
-
Keywords: docs,docstrings,documentation,framework,internet,markdown
|
|
12
9
|
Classifier: Development Status :: 4 - Beta
|
|
13
10
|
Classifier: Intended Audience :: Developers
|
|
14
11
|
Classifier: Operating System :: OS Independent
|
|
15
12
|
Classifier: Programming Language :: Python :: 3
|
|
16
13
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
17
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
18
14
|
Classifier: Programming Language :: Python :: 3.13
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
19
16
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
20
17
|
Classifier: Topic :: Documentation
|
|
21
18
|
Classifier: Topic :: Internet
|
|
22
19
|
Classifier: Topic :: Software Development :: Documentation
|
|
23
20
|
Classifier: Topic :: Software Development :: User Interfaces
|
|
24
21
|
Classifier: Topic :: Text Processing :: Markup :: Markdown
|
|
25
|
-
Requires-
|
|
22
|
+
Requires-Dist: anyenv>=0.1.0
|
|
26
23
|
Requires-Dist: jinja2
|
|
27
24
|
Requires-Dist: jinjarope
|
|
25
|
+
Requires-Dist: logfire
|
|
28
26
|
Requires-Dist: mkdocs>=1.5
|
|
29
27
|
Requires-Dist: mknodes
|
|
30
28
|
Requires-Dist: opentelemetry-instrumentation-jinja2
|
|
@@ -35,8 +33,13 @@ Requires-Dist: pydantic
|
|
|
35
33
|
Requires-Dist: rich
|
|
36
34
|
Requires-Dist: typer
|
|
37
35
|
Requires-Dist: universal-pathlib
|
|
36
|
+
Requires-Dist: upathtools>=0.6.5
|
|
38
37
|
Requires-Dist: yamling
|
|
39
38
|
Requires-Dist: yarl>=1.17.1
|
|
39
|
+
Requires-Python: >=3.13
|
|
40
|
+
Project-URL: Documentation, https://phil65.github.io/mkdocs-mknodes/
|
|
41
|
+
Project-URL: Gitter, https://app.gitter.im/#/room/#mknodes:gitter.im
|
|
42
|
+
Project-URL: Source, https://github.com/phil65/mkdocs_mknodes
|
|
40
43
|
Description-Content-Type: text/markdown
|
|
41
44
|
|
|
42
45
|
``` py title='__main__.create_github_index_md' linenums="86" hl_lines="3"
|
|
@@ -1,58 +1,58 @@
|
|
|
1
|
-
``` py title='__main__.create_github_index_md' linenums="86" hl_lines="3"
|
|
2
|
-
def create_github_index_md() -> mk.MkPage:
|
|
3
|
-
page = mk.MkPage("Github index")
|
|
4
|
-
page += mk.MkCode.for_object(create_github_index_md)
|
|
5
|
-
page += mk.MkHeader("MkNodes", level=1)
|
|
6
|
-
page += mk.MkHeader("Don't write docs. Code them.", level=4)
|
|
7
|
-
page += mk.MkShields()
|
|
8
|
-
page += mk.MkLink(DOC_URL, "Read the completely coded documentation!")
|
|
9
|
-
page += mk.MkInstallGuide(header="How to install")
|
|
10
|
-
page += mk.MkHeader("All the nodes!")
|
|
11
|
-
page += mk.MkClassDiagram(mk.MkNode, mode="subclasses", direction="LR")
|
|
12
|
-
return page
|
|
13
|
-
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
# MkNodes (Mkdocs Plugin)
|
|
17
|
-
|
|
18
|
-
#### Don't write docs. Code them.
|
|
19
|
-
|
|
20
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
21
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
22
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
23
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
24
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
25
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
26
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
27
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
28
|
-
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
29
|
-
[](https://github.com/phil65/mkdocs_mknodes/releases)
|
|
30
|
-
[](https://github.com/phil65/mkdocs_mknodes/graphs/contributors)
|
|
31
|
-
[](https://github.com/phil65/mkdocs_mknodes/discussions)
|
|
32
|
-
[](https://github.com/phil65/mkdocs_mknodes/forks)
|
|
33
|
-
[](https://github.com/phil65/mkdocs_mknodes/issues)
|
|
34
|
-
[](https://github.com/phil65/mkdocs_mknodes/pulls)
|
|
35
|
-
[](https://github.com/phil65/mkdocs_mknodes/watchers)
|
|
36
|
-
[](https://github.com/phil65/mkdocs_mknodes/stars)
|
|
37
|
-
[](https://github.com/phil65/mkdocs_mknodes)
|
|
38
|
-
[](https://github.com/phil65/mkdocs_mknodes/commits)
|
|
39
|
-
[](https://github.com/phil65/mkdocs_mknodes/releases)
|
|
40
|
-
[](https://github.com/phil65/mkdocs_mknodes)
|
|
41
|
-
[](https://github.com/phil65/mkdocs_mknodes)
|
|
42
|
-
[](https://github.com/phil65/mkdocs_mknodes)
|
|
43
|
-
[](https://github.com/phil65/mkdocs_mknodes)
|
|
44
|
-
[](https://codecov.io/gh/phil65/mkdocs_mknodes/)
|
|
45
|
-
[](https://github.com/psf/black)
|
|
46
|
-
[](https://pyup.io/repos/github/phil65/mkdocs_mknodes/)
|
|
47
|
-
|
|
48
|
-
[Read the completely coded documentation!](https://phil65.github.io/mkdocs-mknodes/)
|
|
49
|
-
|
|
50
|
-
## How to install
|
|
51
|
-
|
|
52
|
-
### pip
|
|
53
|
-
|
|
54
|
-
The latest released version is available at the [Python package index](https://pypi.org/project/mknodes).
|
|
55
|
-
|
|
56
|
-
``` py
|
|
57
|
-
pip install mkdocs-mknodes
|
|
58
|
-
```
|
|
1
|
+
``` py title='__main__.create_github_index_md' linenums="86" hl_lines="3"
|
|
2
|
+
def create_github_index_md() -> mk.MkPage:
|
|
3
|
+
page = mk.MkPage("Github index")
|
|
4
|
+
page += mk.MkCode.for_object(create_github_index_md)
|
|
5
|
+
page += mk.MkHeader("MkNodes", level=1)
|
|
6
|
+
page += mk.MkHeader("Don't write docs. Code them.", level=4)
|
|
7
|
+
page += mk.MkShields()
|
|
8
|
+
page += mk.MkLink(DOC_URL, "Read the completely coded documentation!")
|
|
9
|
+
page += mk.MkInstallGuide(header="How to install")
|
|
10
|
+
page += mk.MkHeader("All the nodes!")
|
|
11
|
+
page += mk.MkClassDiagram(mk.MkNode, mode="subclasses", direction="LR")
|
|
12
|
+
return page
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
# MkNodes (Mkdocs Plugin)
|
|
17
|
+
|
|
18
|
+
#### Don't write docs. Code them.
|
|
19
|
+
|
|
20
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
21
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
22
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
23
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
24
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
25
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
26
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
27
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
28
|
+
[](https://pypi.org/project/mkdocs-mknodes/)
|
|
29
|
+
[](https://github.com/phil65/mkdocs_mknodes/releases)
|
|
30
|
+
[](https://github.com/phil65/mkdocs_mknodes/graphs/contributors)
|
|
31
|
+
[](https://github.com/phil65/mkdocs_mknodes/discussions)
|
|
32
|
+
[](https://github.com/phil65/mkdocs_mknodes/forks)
|
|
33
|
+
[](https://github.com/phil65/mkdocs_mknodes/issues)
|
|
34
|
+
[](https://github.com/phil65/mkdocs_mknodes/pulls)
|
|
35
|
+
[](https://github.com/phil65/mkdocs_mknodes/watchers)
|
|
36
|
+
[](https://github.com/phil65/mkdocs_mknodes/stars)
|
|
37
|
+
[](https://github.com/phil65/mkdocs_mknodes)
|
|
38
|
+
[](https://github.com/phil65/mkdocs_mknodes/commits)
|
|
39
|
+
[](https://github.com/phil65/mkdocs_mknodes/releases)
|
|
40
|
+
[](https://github.com/phil65/mkdocs_mknodes)
|
|
41
|
+
[](https://github.com/phil65/mkdocs_mknodes)
|
|
42
|
+
[](https://github.com/phil65/mkdocs_mknodes)
|
|
43
|
+
[](https://github.com/phil65/mkdocs_mknodes)
|
|
44
|
+
[](https://codecov.io/gh/phil65/mkdocs_mknodes/)
|
|
45
|
+
[](https://github.com/psf/black)
|
|
46
|
+
[](https://pyup.io/repos/github/phil65/mkdocs_mknodes/)
|
|
47
|
+
|
|
48
|
+
[Read the completely coded documentation!](https://phil65.github.io/mkdocs-mknodes/)
|
|
49
|
+
|
|
50
|
+
## How to install
|
|
51
|
+
|
|
52
|
+
### pip
|
|
53
|
+
|
|
54
|
+
The latest released version is available at the [Python package index](https://pypi.org/project/mknodes).
|
|
55
|
+
|
|
56
|
+
``` py
|
|
57
|
+
pip install mkdocs-mknodes
|
|
58
|
+
```
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
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"]
|
|
1
|
+
from .mkdefaultwebsite import MkDefaultWebsite
|
|
2
|
+
from . import telemetry
|
|
3
|
+
from importlib.metadata import version
|
|
4
|
+
|
|
5
|
+
telemetry.setup_logfire()
|
|
6
|
+
|
|
7
|
+
__version__ = version("mkdocs-mknodes")
|
|
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"]
|