mkdocs-mknodes 0.3.5__tar.gz → 0.3.6__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.3.5 → mkdocs_mknodes-0.3.6}/.pre-commit-config.yaml +1 -1
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/PKG-INFO +1 -1
- mkdocs_mknodes-0.3.6/configs/mkdocs_mkdocstrings.yml +24 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/duties.py +15 -13
- mkdocs_mknodes-0.3.6/mkdocs_mknodes/__init__.py +1 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/buildcollector.py +13 -3
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/commands/build_page.py +3 -3
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/root.py +0 -1
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/pyproject.toml +4 -0
- mkdocs_mknodes-0.3.5/configs/mkdocs_mkdocstrings.yml +0 -24
- mkdocs_mknodes-0.3.5/mkdocs_mknodes/__init__.py +0 -1
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/.editorconfig +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/.github/README.md +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/.github/workflows/build.yml +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/.github/workflows/documentation.yml +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/.gitignore +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/LICENSE +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/README.md +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/configs/mkdocs_mkdocs.yml +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/configs/mkdocs_multipage.yml +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/configs/mkdocs_shared.yml +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/docs/assets/cli.gif +0 -0
- {mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/build_process.jinja +0 -0
- {mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/cli_index.jinja +0 -0
- {mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/github_index.jinja +0 -0
- {mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/index.jinja +0 -0
- {mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/plugin_configuration.jinja +0 -0
- {mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/use_case_by_config.jinja +0 -0
- {mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/use_case_default_website.jinja +0 -0
- {mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/use_case_subwebsites.jinja +0 -0
- {mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/use_cases_index.jinja +0 -0
- {mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/why_should_i_use_mknodes.jinja +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs.yml +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/backends/__init__.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/backends/buildbackend.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/backends/markdownbackend.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/backends/mkdocsbackend.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/buildcontext.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/cli/__init__.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/cli/richstate.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/commands/__init__.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/commands/serve.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/__init__.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/cli_section.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/get_started_section.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/github_index.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/multi_project.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/manual/use_cases_section.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/mkdocsconfig.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/paths.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/plugin/__init__.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/plugin/mkdocsbuilder.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/plugin/mkdocshelpers.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/plugin/pluginconfig.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/plugin/rewriteloader.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/py.typed +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/resources/mkdocs_basic.yml +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes/resources/timeline_data.toml +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/mkdocs_mknodes.sublime-project +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/overrides/_dummy.txt +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/overrides/partials/actions.html +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/tests/__init__.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/tests/conftest.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/tests/data/objects.inv +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/tests/test_build.py +0 -0
- {mkdocs_mknodes-0.3.5 → mkdocs_mknodes-0.3.6}/tests/test_cli.py +0 -0
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
INHERIT: mkdocs_shared.yml
|
|
2
|
+
|
|
3
|
+
site_name: MkDocstrings
|
|
4
|
+
site_description: A MkDocstrings page created by MkNodes
|
|
5
|
+
repo_url: "https://github.com/mkdocstrings/mkdocstrings/"
|
|
6
|
+
site_url: https://phil65.github.io/mknodes/mkdocstrings/
|
|
7
|
+
plugins:
|
|
8
|
+
- mknodes:
|
|
9
|
+
repo_path: https://github.com/mkdocstrings/mkdocstrings.git
|
|
10
|
+
clone_depth: 100
|
|
11
|
+
build_fn: mknodes.navs.mkemptywebsite:MkEmptyWebsite.for_project
|
|
12
|
+
kwargs:
|
|
13
|
+
static_pages:
|
|
14
|
+
Development:
|
|
15
|
+
- Changelog: "{{ mk.MkChangelog() }}"
|
|
16
|
+
- Code of conduct: "{{ mk.MkCodeOfConduct() }}"
|
|
17
|
+
- Commit conventions: "{{ mk.MkCommitConventions() }}"
|
|
18
|
+
- Pull requests: "{{ mk.MkPullRequestGuidelines() }}"
|
|
19
|
+
- Development environment: "{{ mk.MkDevEnvSetup() }}"
|
|
20
|
+
- Tools: "{{ mk.MkDevTools() }}"
|
|
21
|
+
- Dependencies: "{{ mk.MkDependencyTable() }}"
|
|
22
|
+
- Module overview: "{{ mk.MkModuleOverview() }}"
|
|
23
|
+
- Plugin flow: "{{ mk.MkPluginFlow() }}"
|
|
24
|
+
- License: "{{ mk.MkLicense() }}"
|
|
@@ -12,23 +12,24 @@ UPDATE_CMD = f"""{ENV_PREFIX}python -m pip list {" ".join(PARAMS)}"""
|
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
@duty(capture=False)
|
|
15
|
-
def build(ctx):
|
|
15
|
+
def build(ctx, *args: str):
|
|
16
16
|
"""Build a MkNodes page."""
|
|
17
|
-
|
|
17
|
+
args_str = " " + " ".join(args) if args else ""
|
|
18
|
+
ctx.run(f"{ENV_PREFIX}mknodes build{args_str}")
|
|
18
19
|
|
|
19
20
|
|
|
20
21
|
@duty(capture=False)
|
|
21
|
-
def serve(ctx, args: str
|
|
22
|
+
def serve(ctx, *args: str):
|
|
22
23
|
"""Serve a MkNodes page."""
|
|
23
|
-
|
|
24
|
-
ctx.run(f"{ENV_PREFIX}mknodes serve{
|
|
24
|
+
args_str = " " + " ".join(args) if args else ""
|
|
25
|
+
ctx.run(f"{ENV_PREFIX}mknodes serve{args_str}")
|
|
25
26
|
|
|
26
27
|
|
|
27
28
|
@duty(capture=False)
|
|
28
|
-
def test(ctx, args: str
|
|
29
|
+
def test(ctx, *args: str):
|
|
29
30
|
"""Serve a MkNodes page."""
|
|
30
|
-
|
|
31
|
-
ctx.run(f"{ENV_PREFIX}pytest{
|
|
31
|
+
args_str = " " + " ".join(args) if args else ""
|
|
32
|
+
ctx.run(f"{ENV_PREFIX}pytest{args_str}")
|
|
32
33
|
|
|
33
34
|
|
|
34
35
|
@duty(capture=False)
|
|
@@ -38,15 +39,16 @@ def clean(ctx):
|
|
|
38
39
|
|
|
39
40
|
|
|
40
41
|
@duty
|
|
41
|
-
def update(ctx):
|
|
42
|
+
def update(ctx, *args: str):
|
|
42
43
|
"""Update all environment packages using pip directly."""
|
|
43
|
-
|
|
44
|
+
args_str = " " + " ".join(args) if args else ""
|
|
45
|
+
requirements = ctx.run(UPDATE_CMD + args_str)
|
|
44
46
|
requirements = "\n".join(requirements.split("\n")[1:])
|
|
45
47
|
packages = [x["name"] for x in json.loads(requirements)]
|
|
46
48
|
if packages:
|
|
47
|
-
|
|
48
|
-
print(f"Packages to update: {
|
|
49
|
-
ctx.run(f"{ENV_PREFIX}python -m pip install -U {
|
|
49
|
+
pkgs = " ".join(packages)
|
|
50
|
+
print(f"Packages to update: {pkgs}")
|
|
51
|
+
ctx.run(f"{ENV_PREFIX}python -m pip install -U {pkgs}{args_str}", capture=False)
|
|
50
52
|
else:
|
|
51
53
|
print("No packages to update!")
|
|
52
54
|
ctx.run(f"{ENV_PREFIX}python -m pip install -e .", capture=False)
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.3.6"
|
|
@@ -88,7 +88,7 @@ def update_nav_template(nav: mk.MkNav):
|
|
|
88
88
|
def process_resources(page: mk.MkPage) -> resources.Resources:
|
|
89
89
|
"""Add resources from page to its template and return the "filtered" resources."""
|
|
90
90
|
req = page.get_resources()
|
|
91
|
-
js_reqs = []
|
|
91
|
+
js_reqs: list[resources.JSFile] = []
|
|
92
92
|
prefix = "../" * (len(page.resolved_parts) + 1)
|
|
93
93
|
for i in req.js:
|
|
94
94
|
if isinstance(i, resources.JSText):
|
|
@@ -109,10 +109,14 @@ def process_resources(page: mk.MkPage) -> resources.Resources:
|
|
|
109
109
|
req.assets += assets
|
|
110
110
|
req.js = []
|
|
111
111
|
for lib in libs:
|
|
112
|
+
msg = f"Adding {lib.link!r} lib to {page.resolved_file_path!r} template"
|
|
113
|
+
logger.info(msg)
|
|
112
114
|
page.template.libs.add_script_file(lib)
|
|
113
115
|
for lib in non_libs:
|
|
116
|
+
msg = f"Adding {lib.link!r} script to {page.resolved_file_path!r} template"
|
|
117
|
+
logger.info(msg)
|
|
114
118
|
page.template.scripts.add_script_file(lib)
|
|
115
|
-
css_reqs = []
|
|
119
|
+
css_reqs: list[resources.CSSFile] = []
|
|
116
120
|
for i in req.css:
|
|
117
121
|
if isinstance(i, resources.CSSText):
|
|
118
122
|
css_file = resources.CSSFile(link=f"{prefix}assets/{i.resolved_filename}")
|
|
@@ -123,6 +127,8 @@ def process_resources(page: mk.MkPage) -> resources.Resources:
|
|
|
123
127
|
req.assets += assets
|
|
124
128
|
req.css = []
|
|
125
129
|
for css_ in css_reqs:
|
|
130
|
+
msg = f"Adding {css_.link!r} stylesheet to {page.resolved_file_path!r} template"
|
|
131
|
+
logger.info(msg)
|
|
126
132
|
page.template.styles.add_stylesheet(css_)
|
|
127
133
|
return req
|
|
128
134
|
|
|
@@ -202,7 +208,11 @@ class BuildCollector:
|
|
|
202
208
|
i.template if isinstance(i, mk.MkPage) else i.page_template
|
|
203
209
|
for i in self.mapping.values()
|
|
204
210
|
]
|
|
205
|
-
|
|
211
|
+
if isinstance(theme.templates, dict):
|
|
212
|
+
vals = theme.templates.values()
|
|
213
|
+
else:
|
|
214
|
+
vals = theme.templates
|
|
215
|
+
templates += list(vals)
|
|
206
216
|
templates = [i for i in templates if i]
|
|
207
217
|
build_files = self.node_files | self.extra_files
|
|
208
218
|
for backend in self.backends:
|
|
@@ -21,7 +21,7 @@ from mkdocs.structure.files import InclusionLevel, _set_exclusions, get_files
|
|
|
21
21
|
from mkdocs.structure.nav import get_navigation
|
|
22
22
|
from mkdocs.structure.pages import Page
|
|
23
23
|
from mknodes.info import mkdocsconfigfile
|
|
24
|
-
from mknodes.utils import yamlhelpers
|
|
24
|
+
from mknodes.utils import pathhelpers, yamlhelpers
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
if TYPE_CHECKING:
|
|
@@ -34,7 +34,7 @@ logger = get_plugin_logger(__name__)
|
|
|
34
34
|
def build(
|
|
35
35
|
config_path: str | os.PathLike,
|
|
36
36
|
repo_path: str,
|
|
37
|
-
build_fn,
|
|
37
|
+
build_fn: str | None,
|
|
38
38
|
site_dir: str | None = None,
|
|
39
39
|
clone_depth: int = 100,
|
|
40
40
|
**kwargs,
|
|
@@ -133,7 +133,7 @@ def _build(
|
|
|
133
133
|
|
|
134
134
|
if not dirty:
|
|
135
135
|
logger.info("Cleaning site directory")
|
|
136
|
-
|
|
136
|
+
pathhelpers.clean_directory(config.site_dir)
|
|
137
137
|
else: # pragma: no cover
|
|
138
138
|
logger.warning("A 'dirty' build is being performed (for site dev purposes only)")
|
|
139
139
|
if not live_server_url: # pragma: no cover
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
INHERIT: mkdocs_shared.yml
|
|
2
|
-
|
|
3
|
-
site_name: MkDocstrings
|
|
4
|
-
site_description: A MkDocstrings page created by MkNodes
|
|
5
|
-
repo_url: "https://github.com/mkdocstrings/mkdocstrings/"
|
|
6
|
-
site_url: https://phil65.github.io/mknodes/mkdocstrings/
|
|
7
|
-
plugins:
|
|
8
|
-
- mknodes:
|
|
9
|
-
repo_path: https://github.com/mkdocstrings/mkdocstrings.git
|
|
10
|
-
clone_depth: 100
|
|
11
|
-
build_fn: mknodes.navs.mkemptywebsite:MkEmptyWebsite.for_project
|
|
12
|
-
kwargs:
|
|
13
|
-
static_pages:
|
|
14
|
-
Development:
|
|
15
|
-
- Changelog: ->MkChangelog
|
|
16
|
-
- Code of conduct: ->MkCodeOfConduct
|
|
17
|
-
- Commit conventions: ->MkCommitConventions
|
|
18
|
-
- Pull requests: ->MkPullRequestGuidelines
|
|
19
|
-
- Development environment: ->MkDevEnvSetup
|
|
20
|
-
- Tools: ->MkDevTools
|
|
21
|
-
- Dependencies: ->MkDependencyTable
|
|
22
|
-
- Module overview: ->MkModuleOverview
|
|
23
|
-
- Plugin flow: ->MkPluginFlow
|
|
24
|
-
- License: ->MkLicense
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
__version__ = "0.3.5"
|
|
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.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/build_process.jinja
RENAMED
|
File without changes
|
|
File without changes
|
{mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/github_index.jinja
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/use_case_by_config.jinja
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{mkdocs_mknodes-0.3.5/mkdocs_mknodes/resources → mkdocs_mknodes-0.3.6/docs}/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
|
|
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
|