mkdocs-mknodes 0.2.0__tar.gz → 0.2.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.2.0 → mkdocs_mknodes-0.2.2}/PKG-INFO +1 -1
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/configs/mkdocs_mkdocs.yml +1 -1
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/configs/mkdocs_mkdocstrings.yml +2 -2
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/configs/mkdocs_multipage.yml +1 -1
- mkdocs_mknodes-0.2.2/mkdocs_mknodes/__init__.py +1 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/cli/__init__.py +5 -3
- mkdocs_mknodes-0.2.2/mkdocs_mknodes/manual/__init__.py +1 -0
- mkdocs_mknodes-0.2.2/mkdocs_mknodes/manual/cli_section.py +28 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/manual/get_started_section.py +7 -9
- mkdocs_mknodes-0.2.2/mkdocs_mknodes/manual/root.py +34 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/manual/use_cases_section.py +2 -5
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/paths.py +3 -2
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/plugin/__init__.py +44 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/plugin/rewriteloader.py +5 -0
- {mkdocs_mknodes-0.2.0/configs → mkdocs_mknodes-0.2.2/mkdocs_mknodes/resources}/mkdocs_basic.yml +13 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/tests/test_cli.py +6 -0
- mkdocs_mknodes-0.2.0/mkdocs_mknodes/__init__.py +0 -1
- mkdocs_mknodes-0.2.0/mkdocs_mknodes/manual/__init__.py +0 -13
- mkdocs_mknodes-0.2.0/mkdocs_mknodes/manual/cli_section.py +0 -37
- mkdocs_mknodes-0.2.0/mkdocs_mknodes/manual/dev_section.py +0 -55
- mkdocs_mknodes-0.2.0/mkdocs_mknodes/manual/internals_section.py +0 -9
- mkdocs_mknodes-0.2.0/mkdocs_mknodes/manual/root.py +0 -25
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/.editorconfig +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/.github/README.md +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/.github/workflows/build.yml +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/.github/workflows/documentation.yml +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/.gitignore +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/.pre-commit-config.yaml +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/LICENSE +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/Makefile +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/README.md +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/docs/assets/cli.gif +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs.yml +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/backends/__init__.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/backends/buildbackend.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/backends/markdownbackend.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/backends/mkdocsbackend.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/buildcollector.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/cli/richstate.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/commands/__init__.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/commands/build_page.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/commands/create_page.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/commands/serve.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/manual/github_index.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/manual/multi_project.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/mkdocsconfig.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/plugin/mkdocsbuilder.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/plugin/pluginconfig.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/build_process.jinja +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/cli_index.jinja +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/github_index.jinja +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/index.jinja +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/plugin_configuration.jinja +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/use_case_by_config.jinja +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/use_case_default_website.jinja +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/use_case_subwebsites.jinja +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/use_cases_index.jinja +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/why_should_i_use_mknodes.jinja +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes.sublime-project +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/overrides/_dummy.txt +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/overrides/partials/actions.html +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/pyproject.toml +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/tests/__init__.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/tests/conftest.py +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/tests/data/objects.inv +0 -0
- {mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/tests/test_build.py +0 -0
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
INHERIT: mkdocs_basic.yml
|
|
1
|
+
INHERIT: ../mkdocs_mknodes/resources/mkdocs_basic.yml
|
|
2
2
|
|
|
3
3
|
site_name: MkDocstrings
|
|
4
4
|
site_description: A MkDocstrings page created by MkNodes
|
|
@@ -7,8 +7,8 @@ site_url: https://phil65.github.io/mknodes/mkdocstrings/
|
|
|
7
7
|
plugins:
|
|
8
8
|
- mknodes:
|
|
9
9
|
repo_path: https://github.com/mkdocstrings/mkdocstrings.git
|
|
10
|
-
build_fn: mknodes.navs.mkemptywebsite:MkEmptyWebsite.for_project
|
|
11
10
|
clone_depth: 100
|
|
11
|
+
build_fn: mknodes.navs.mkemptywebsite:MkEmptyWebsite.for_project
|
|
12
12
|
kwargs:
|
|
13
13
|
static_pages:
|
|
14
14
|
Development:
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.2.2"
|
|
@@ -8,7 +8,7 @@ import typer as t
|
|
|
8
8
|
|
|
9
9
|
from mknodes.utils import log, yamlhelpers
|
|
10
10
|
|
|
11
|
-
from mkdocs_mknodes import paths
|
|
11
|
+
from mkdocs_mknodes import buildcollector, paths
|
|
12
12
|
from mkdocs_mknodes.cli import richstate
|
|
13
13
|
from mkdocs_mknodes.commands import build_page, serve as serve_
|
|
14
14
|
|
|
@@ -151,7 +151,7 @@ def create_config(
|
|
|
151
151
|
theme_name = theme or "material"
|
|
152
152
|
config = {
|
|
153
153
|
"site_name": "Not set",
|
|
154
|
-
"theme": theme_name,
|
|
154
|
+
"theme": {"name": theme_name, "custom_dir": "overrides"},
|
|
155
155
|
"use_directory_urls": use_directory_urls,
|
|
156
156
|
"extra": {},
|
|
157
157
|
"plugins": [
|
|
@@ -173,7 +173,9 @@ def create_config(
|
|
|
173
173
|
build_fn=build_fn,
|
|
174
174
|
clone_depth=1,
|
|
175
175
|
)
|
|
176
|
-
|
|
176
|
+
proj.build()
|
|
177
|
+
collector = buildcollector.BuildCollector([])
|
|
178
|
+
info = collector.collect(proj._root, skin)
|
|
177
179
|
resources = info.resources
|
|
178
180
|
info = proj.context.metadata
|
|
179
181
|
config["markdown_extensions"] = resources.markdown_extensions
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""Module containing the documentation."""
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import mknodes as mk
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
# this is the nav we will populate via decorators.
|
|
5
|
+
nav = mk.MkNav("CLI")
|
|
6
|
+
|
|
7
|
+
CLI_PATH = "mkdocs_mknodes.cli:cli"
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
@nav.route.page(is_index=True, hide="toc")
|
|
11
|
+
def _(page: mk.MkPage):
|
|
12
|
+
page += mk.MkBinaryImage.for_file("docs/assets/cli.gif")
|
|
13
|
+
page += mk.MkJinjaTemplate("cli_index.jinja")
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
@nav.route.page("build", icon="wrench")
|
|
17
|
+
def _(page: mk.MkPage):
|
|
18
|
+
page += mk.MkClickDoc(CLI_PATH, prog_name="build")
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
@nav.route.page("serve", icon="web")
|
|
22
|
+
def _(page: mk.MkPage):
|
|
23
|
+
page += mk.MkClickDoc(CLI_PATH, prog_name="serve")
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
@nav.route.page("create-config", icon="folder-wrench")
|
|
27
|
+
def _(page: mk.MkPage):
|
|
28
|
+
page += mk.MkClickDoc(CLI_PATH, prog_name="create-config")
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
from __future__ import annotations
|
|
2
2
|
|
|
3
|
-
import tomllib
|
|
4
|
-
|
|
5
3
|
import mknodes as mk
|
|
6
4
|
|
|
7
5
|
from mkdocs_mknodes import paths
|
|
@@ -31,7 +29,7 @@ def _(page: mk.MkPage):
|
|
|
31
29
|
page += mk.MkJinjaTemplate("plugin_configuration.jinja")
|
|
32
30
|
eps = page.ctx.metadata.entry_points.get("mkdocs.plugins", [])
|
|
33
31
|
page += mk.MkDocStrings(
|
|
34
|
-
eps[0].
|
|
32
|
+
eps[0].load().config_class,
|
|
35
33
|
show_root_toc_entry=False,
|
|
36
34
|
show_if_no_docstring=True,
|
|
37
35
|
heading_level=4,
|
|
@@ -42,10 +40,10 @@ def _(page: mk.MkPage):
|
|
|
42
40
|
|
|
43
41
|
@router.route_page("The build process", hide="toc")
|
|
44
42
|
def _(page: mk.MkPage):
|
|
45
|
-
text = (paths.RESOURCES / "timeline_data.toml").read_text()
|
|
46
|
-
data = tomllib.loads(text)
|
|
47
43
|
page += INTRO
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
44
|
+
page += mk.MkTimeline(paths.RESOURCES / "timeline_data.toml")
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
@router.route_page("Plugin flow", icon="dev-to")
|
|
48
|
+
def _(page: mk.MkPage):
|
|
49
|
+
page += mk.MkPluginFlow()
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import mknodes as mk
|
|
4
|
+
|
|
5
|
+
from mknodes.manual import dev_section
|
|
6
|
+
|
|
7
|
+
from mkdocs_mknodes.manual import cli_section, get_started_section, use_cases_section
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Build:
|
|
11
|
+
def on_theme(self, theme: mk.MaterialTheme):
|
|
12
|
+
theme.error_page.content = mk.MkAdmonition("Page does not exist!")
|
|
13
|
+
theme.content_area_width = 1300
|
|
14
|
+
theme.tooltip_width = 800
|
|
15
|
+
|
|
16
|
+
def on_root(self, nav: mk.MkNav):
|
|
17
|
+
nav.page_template.announcement_bar = mk.MkMetadataBadges("websites")
|
|
18
|
+
get_started_nav = mk.MkNav("Get started", parent=nav)
|
|
19
|
+
get_started_section.router.register_nodes(get_started_nav)
|
|
20
|
+
nav += get_started_nav
|
|
21
|
+
nav += use_cases_section.nav
|
|
22
|
+
doc = nav.add_doc(section_name="API", flatten_nav=True)
|
|
23
|
+
doc.collect_classes(recursive=True)
|
|
24
|
+
nav += cli_section.nav
|
|
25
|
+
nav += dev_section.nav
|
|
26
|
+
return nav
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
def build(project: mk.Project[mk.MaterialTheme]) -> mk.MkNav:
|
|
30
|
+
build = Build()
|
|
31
|
+
project.env.add_template_path("mkdocs_mknodes/resources")
|
|
32
|
+
nav = project.get_root()
|
|
33
|
+
build.on_theme(project.theme)
|
|
34
|
+
return build.on_root(nav) or nav
|
|
@@ -6,12 +6,9 @@ from mknodes.info import mkdocsconfigfile
|
|
|
6
6
|
nav = mk.MkNav("Use cases")
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
root_nav += nav
|
|
12
|
-
page = nav.add_page(is_index=True, hide="toc")
|
|
9
|
+
@nav.route.page(is_index=True, hide="toc")
|
|
10
|
+
def _(page: mk.MkPage):
|
|
13
11
|
page += mk.MkJinjaTemplate("use_cases_index.jinja")
|
|
14
|
-
page.created_by = create_use_cases_section
|
|
15
12
|
|
|
16
13
|
|
|
17
14
|
@nav.route.page("Creating a website via config", hide="toc")
|
|
@@ -5,6 +5,7 @@ from __future__ import annotations
|
|
|
5
5
|
import pathlib
|
|
6
6
|
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
RESOURCES =
|
|
8
|
+
SRC_FOLDER = pathlib.Path(__file__).parent
|
|
9
|
+
RESOURCES = SRC_FOLDER / "resources"
|
|
10
|
+
CFG_DEFAULT = RESOURCES / "mkdocs_basic.yml"
|
|
10
11
|
DEFAULT_BUILD_FN = "mknodes:MkDefaultWebsite.for_project"
|
|
@@ -32,6 +32,50 @@ logger = get_plugin_logger(__name__)
|
|
|
32
32
|
CommandStr = Literal["build", "serve", "gh-deploy"]
|
|
33
33
|
|
|
34
34
|
|
|
35
|
+
class Build:
|
|
36
|
+
def setup_build_folder(self, build_folder):
|
|
37
|
+
if build_folder:
|
|
38
|
+
self.build_folder = pathlib.Path(build_folder)
|
|
39
|
+
else:
|
|
40
|
+
self._dir = tempfile.TemporaryDirectory(prefix="mknodes_")
|
|
41
|
+
self.build_folder = pathlib.Path(self._dir.name)
|
|
42
|
+
logger.debug("Creating temporary dir %s", self._dir.name)
|
|
43
|
+
|
|
44
|
+
def setup_project(
|
|
45
|
+
self,
|
|
46
|
+
build_fn,
|
|
47
|
+
repo_path,
|
|
48
|
+
theme,
|
|
49
|
+
base_url,
|
|
50
|
+
use_directory_urls: bool = True,
|
|
51
|
+
clone_depth: int = 100,
|
|
52
|
+
**kwargs,
|
|
53
|
+
):
|
|
54
|
+
if not build_fn:
|
|
55
|
+
return
|
|
56
|
+
self.project = mk.Project(
|
|
57
|
+
base_url=base_url,
|
|
58
|
+
use_directory_urls=use_directory_urls,
|
|
59
|
+
theme=theme,
|
|
60
|
+
repo=repo_path,
|
|
61
|
+
build_fn=build_fn,
|
|
62
|
+
build_kwargs=kwargs,
|
|
63
|
+
clone_depth=clone_depth,
|
|
64
|
+
)
|
|
65
|
+
|
|
66
|
+
def on_build_project(self, backends, show_page_info):
|
|
67
|
+
logger.info("Generating pages...")
|
|
68
|
+
self.project.build()
|
|
69
|
+
|
|
70
|
+
logger.info("Setting up build backends...")
|
|
71
|
+
collector = buildcollector.BuildCollector(
|
|
72
|
+
backends=backends,
|
|
73
|
+
show_page_info=show_page_info,
|
|
74
|
+
)
|
|
75
|
+
assert self.project._root
|
|
76
|
+
self.build_info = collector.collect(self.project._root, self.project.theme)
|
|
77
|
+
|
|
78
|
+
|
|
35
79
|
class MkNodesPlugin(BasePlugin[pluginconfig.PluginConfig]):
|
|
36
80
|
def __init__(self, **kwargs):
|
|
37
81
|
super().__init__(**kwargs)
|
{mkdocs_mknodes-0.2.0/configs → mkdocs_mknodes-0.2.2/mkdocs_mknodes/resources}/mkdocs_basic.yml
RENAMED
|
@@ -6,6 +6,19 @@ site_dir: ../site
|
|
|
6
6
|
theme:
|
|
7
7
|
name: material
|
|
8
8
|
custom_dir: ../overrides
|
|
9
|
+
palette:
|
|
10
|
+
- media: "(prefers-color-scheme: light)"
|
|
11
|
+
scheme: default
|
|
12
|
+
primary: custom
|
|
13
|
+
toggle:
|
|
14
|
+
icon: material/brightness-7
|
|
15
|
+
name: Switch to dark mode
|
|
16
|
+
- media: "(prefers-color-scheme: dark)"
|
|
17
|
+
scheme: slate
|
|
18
|
+
primary: custom
|
|
19
|
+
toggle:
|
|
20
|
+
icon: material/brightness-4
|
|
21
|
+
name: Switch to light mode
|
|
9
22
|
features:
|
|
10
23
|
- announce.dismiss
|
|
11
24
|
- navigation.tabs # make top level tabs
|
|
@@ -48,3 +48,9 @@ def test_serve_default(mock_build, mock_serve):
|
|
|
48
48
|
|
|
49
49
|
assert result.exit_code == 0
|
|
50
50
|
mock_build.assert_called_once()
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
def test_create_config():
|
|
54
|
+
runner = CliRunner()
|
|
55
|
+
result = runner.invoke(cli.cli, ["create-config"], catch_exceptions=False)
|
|
56
|
+
assert result.exit_code == 0
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
__version__ = "0.2.0"
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
"""Module containing the documentation."""
|
|
2
|
-
|
|
3
|
-
from .cli_section import create_cli_section
|
|
4
|
-
from .dev_section import create_development_section
|
|
5
|
-
from .use_cases_section import create_use_cases_section
|
|
6
|
-
from .root import build
|
|
7
|
-
|
|
8
|
-
__all__ = [
|
|
9
|
-
"create_cli_section",
|
|
10
|
-
"create_development_section",
|
|
11
|
-
"create_use_cases_section",
|
|
12
|
-
"build",
|
|
13
|
-
]
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
import mknodes as mk
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
# this is the nav we will populate via decorators.
|
|
5
|
-
nav = mk.MkNav("CLI")
|
|
6
|
-
|
|
7
|
-
CLI_PATH = "mkdocs_mknodes.cli:cli"
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
def create_cli_section(root_nav: mk.MkNav):
|
|
11
|
-
"""Create the "Development" sub-MkNav and attach it to given MkNav."""
|
|
12
|
-
# Now we will create the "Development" section.
|
|
13
|
-
# You might notice that this whole section does not contain any specific
|
|
14
|
-
# reference to mk. That is because all nodes containing metadata are
|
|
15
|
-
# dynamically populated depending on the project the tree is connected to.
|
|
16
|
-
# This means that this section could be imported by other packages and be
|
|
17
|
-
# used without any further adaptation.
|
|
18
|
-
root_nav += nav
|
|
19
|
-
page = nav.add_page(is_index=True, hide="toc")
|
|
20
|
-
page += mk.MkBinaryImage.for_file("docs/assets/cli.gif")
|
|
21
|
-
page += mk.MkJinjaTemplate("cli_index.jinja")
|
|
22
|
-
page.created_by = create_cli_section
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
@nav.route.page("build", icon="wrench")
|
|
26
|
-
def _(page: mk.MkPage):
|
|
27
|
-
page += mk.MkClickDoc(CLI_PATH, prog_name="build")
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
@nav.route.page("serve", icon="web")
|
|
31
|
-
def _(page: mk.MkPage):
|
|
32
|
-
page += mk.MkClickDoc(CLI_PATH, prog_name="serve")
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
@nav.route.page("create-config", icon="folder-wrench")
|
|
36
|
-
def _(page: mk.MkPage):
|
|
37
|
-
page += mk.MkClickDoc(CLI_PATH, prog_name="create-config")
|
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
import mknodes as mk
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
nav = mk.MkNav("Development")
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
def create_development_section(root_nav: mk.MkNav):
|
|
8
|
-
root_nav += nav
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
@nav.route.page("Module overview", icon="file-tree-outline")
|
|
12
|
-
def _(page: mk.MkPage):
|
|
13
|
-
page += mk.MkModuleOverview(maximum_depth=2)
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
@nav.route.page("Plugin flow", icon="dev-to")
|
|
17
|
-
def _(page: mk.MkPage):
|
|
18
|
-
page += mk.MkPluginFlow()
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
@nav.route.page("Changelog", icon="format-list-group")
|
|
22
|
-
def _(page: mk.MkPage):
|
|
23
|
-
page += mk.MkChangelog()
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
@nav.route.page("Code of conduct", icon="octicons/code-of-conduct-24")
|
|
27
|
-
def _(page: mk.MkPage):
|
|
28
|
-
page += mk.MkCodeOfConduct()
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
@nav.route.page("Contributing", icon="help")
|
|
32
|
-
def _(page: mk.MkPage):
|
|
33
|
-
page += mk.MkCommitConventions()
|
|
34
|
-
page += mk.MkPullRequestGuidelines()
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
@nav.route.page("License", hide="toc", icon="license")
|
|
38
|
-
def _(page: mk.MkPage):
|
|
39
|
-
page += mk.MkLicense()
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
@nav.route.page("Dependencies", hide="toc", icon="database")
|
|
43
|
-
def _(page: mk.MkPage):
|
|
44
|
-
page += mk.MkDependencyTable(layout="badge")
|
|
45
|
-
page += mk.MkPipDepTree(direction="LR")
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
@nav.route.page("Development environment", icon="dev-to")
|
|
49
|
-
def _(page: mk.MkPage):
|
|
50
|
-
page += mk.MkDevEnvSetup()
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
@nav.route.page("Dev Tools", icon="wrench")
|
|
54
|
-
def _(page: mk.MkPage):
|
|
55
|
-
page += mk.MkDevTools()
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
from __future__ import annotations
|
|
2
|
-
|
|
3
|
-
import mknodes as mk
|
|
4
|
-
|
|
5
|
-
from mkdocs_mknodes import manual
|
|
6
|
-
from mkdocs_mknodes.manual import get_started_section
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
def build(project: mk.Project[mk.MaterialTheme]) -> mk.MkNav:
|
|
10
|
-
project.env.add_template_path("mkdocs_mknodes/resources")
|
|
11
|
-
project.theme.error_page.content = mk.MkAdmonition("Page does not exist!")
|
|
12
|
-
project.theme.content_area_width = 1300
|
|
13
|
-
project.theme.tooltip_width = 800
|
|
14
|
-
|
|
15
|
-
root_nav = project.get_root()
|
|
16
|
-
root_nav.page_template.announcement_bar = mk.MkMetadataBadges("websites")
|
|
17
|
-
nav = mk.MkNav("Get started", parent=root_nav)
|
|
18
|
-
get_started_section.router.register_nodes(nav)
|
|
19
|
-
root_nav += nav
|
|
20
|
-
manual.create_use_cases_section(root_nav)
|
|
21
|
-
doc = root_nav.add_doc(section_name="API", flatten_nav=True)
|
|
22
|
-
doc.collect_classes(recursive=True)
|
|
23
|
-
manual.create_cli_section(root_nav)
|
|
24
|
-
manual.create_development_section(root_nav)
|
|
25
|
-
return root_nav
|
|
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
|
{mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/plugin_configuration.jinja
RENAMED
|
File without changes
|
|
File without changes
|
{mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/use_case_by_config.jinja
RENAMED
|
File without changes
|
|
File without changes
|
{mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/use_case_subwebsites.jinja
RENAMED
|
File without changes
|
{mkdocs_mknodes-0.2.0 → mkdocs_mknodes-0.2.2}/mkdocs_mknodes/resources/use_cases_index.jinja
RENAMED
|
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
|