mknodes 0.3.2__tar.gz → 0.4.1__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.
- {mknodes-0.3.2 → mknodes-0.4.1}/PKG-INFO +13 -1
- {mknodes-0.3.2 → mknodes-0.4.1}/docs/gen_pages.py +1 -1
- {mknodes-0.3.2 → mknodes-0.4.1}/docs/gen_qt.py +6 -10
- {mknodes-0.3.2 → mknodes-0.4.1}/mkdocs.yml +3 -2
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/__init__.py +3 -3
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/__linkreplacer/linkreplacer.py +17 -1
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/classnodes/mkclasspage.py +1 -1
- mknodes-0.3.2/mknodes/classnodes/mkbaseclasstable.py → mknodes-0.4.1/mknodes/classnodes/mkclasstable.py +5 -5
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/manual/page_2.py +0 -4
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkdoc.py +5 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkdocstrings.py +2 -2
- mknodes-0.4.1/mknodes/mkinstallguide.py +40 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mknode.py +6 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkshields.py +4 -4
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/modulenodes/mkmodulepage.py +6 -5
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/utils/classhelpers.py +1 -1
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/utils/inventorymanager.py +5 -2
- mknodes-0.4.1/mknodes/utils/linkprovider.py +44 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/pyproject.toml +28 -5
- mknodes-0.3.2/mknodes/classnodes/mkclasstable.py +0 -58
- {mknodes-0.3.2 → mknodes-0.4.1}/.editorconfig +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/.github/workflows/build.yml +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/.github/workflows/documentation.yml +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/.gitignore +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/.pre-commit-config.yaml +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/LICENSE +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/Makefile +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/README.md +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/__linkreplacer/__init__.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/classnodes/__init__.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/classnodes/mkclassdiagram.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/manual/__init__.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/manual/page_1.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/manual/page_3.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkadmonition.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkbinaryimage.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkblock.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkcode.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkcontainer.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkcritic.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkdiagram.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkimage.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mklink.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mklist.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mknav.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkpage.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mkpageinclude.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mksnippet.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mksourceandresult.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mktabcontainer.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mktable.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mktabs.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/mktext.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/modulenodes/__init__.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/modulenodes/mkmoduletable.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/node.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/utils/__init__.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/utils/connectionbuilder.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/utils/helpers.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/utils/mermaid.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/mknodes/utils/noderesolver.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/__init__.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/conftest.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/data/nav_tree/SUMMARY.md +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/data/nav_tree/test_file.md +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/data/nav_tree/test_folder/sub_1.md +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/data/nav_tree/test_folder/sub_2.md +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/data/nav_tree/test_subnav/SUMMARY.md +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/data/nav_tree/test_subnav/subnav_page_1.md +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/data/nav_tree/test_subnav/subnav_page_2.md +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_admonition.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_block.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_classdiagram.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_docstrings.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_image.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_list.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_manual.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_markdownnode.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_modulepage.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_nav.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_page.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_tabblock.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_tabcontainer.py +0 -0
- {mknodes-0.3.2 → mknodes-0.4.1}/tests/test_text.py +0 -0
|
@@ -1,12 +1,24 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: mknodes
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.4.1
|
|
4
4
|
Summary: Generate docs with ease.
|
|
5
5
|
Project-URL: Documentation, https://phil65.github.io/mknodes/
|
|
6
6
|
Project-URL: Source, https://github.com/phil65/mknodes
|
|
7
7
|
Author-email: mknodes <philipptemminghoff@gmail.com>
|
|
8
|
+
License-Expression: MIT
|
|
8
9
|
License-File: LICENSE
|
|
10
|
+
Keywords: docs,docstrings,documentation,framework,internet,markdown
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
14
|
+
Classifier: Operating System :: OS Independent
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
16
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Topic :: Documentation
|
|
20
|
+
Classifier: Topic :: Internet
|
|
21
|
+
Classifier: Topic :: Text Processing :: Markup :: Markdown
|
|
10
22
|
Requires-Python: >=3.10
|
|
11
23
|
Requires-Dist: mkdocs
|
|
12
24
|
Requires-Dist: mkdocs-gen-files
|
|
@@ -15,7 +15,7 @@ and without having to care about file paths at at all.
|
|
|
15
15
|
Now check out what we have created!
|
|
16
16
|
"""
|
|
17
17
|
|
|
18
|
-
# this Nav object is basically the root of everything. It corresponds
|
|
18
|
+
# this Nav object is basically the root of everything. It corresponds to your root
|
|
19
19
|
# SUMMARY.md.
|
|
20
20
|
|
|
21
21
|
root_nav = mknodes.MkNav()
|
|
@@ -13,19 +13,15 @@ root_nav = mknodes.MkNav()
|
|
|
13
13
|
page = root_nav.add_index_page(hide_toc=True, hide_nav=True)
|
|
14
14
|
page.add_header("Not in the mood to write documentation? Let´s code it then!", level=3)
|
|
15
15
|
|
|
16
|
-
qt_docs = root_nav.add_doc(prettyqt, section_name="
|
|
17
|
-
extra_docs = root_nav.add_doc(prettyqt, section_name="
|
|
16
|
+
qt_docs = root_nav.add_doc(prettyqt, section_name="qt_modules")
|
|
17
|
+
extra_docs = root_nav.add_doc(prettyqt, section_name="additional_modules")
|
|
18
18
|
|
|
19
19
|
for submod in qt_docs.iter_modules(predicate=lambda x: hasattr(x, QT_MODULE_ATTR)):
|
|
20
|
-
subdoc = qt_docs.add_doc(submod)
|
|
21
|
-
subdoc.
|
|
22
|
-
for klass in subdoc.iter_classes():
|
|
23
|
-
subdoc.add_class_page(klass=klass, flatten=True)
|
|
20
|
+
subdoc = qt_docs.add_doc(submod, flatten_nav=True)
|
|
21
|
+
subdoc.collect_classes()
|
|
24
22
|
for submod in extra_docs.iter_modules(predicate=lambda x: not hasattr(x, QT_MODULE_ATTR)):
|
|
25
|
-
subdoc = extra_docs.add_doc(submod)
|
|
26
|
-
subdoc.
|
|
27
|
-
for klass in subdoc.iter_classes():
|
|
28
|
-
subdoc.add_class_page(klass=klass, flatten=True)
|
|
23
|
+
subdoc = extra_docs.add_doc(submod, flatten_nav=True)
|
|
24
|
+
subdoc.collect_classes()
|
|
29
25
|
|
|
30
26
|
|
|
31
27
|
# root_nav.pretty_print()
|
|
@@ -46,8 +46,8 @@ plugins:
|
|
|
46
46
|
- tags
|
|
47
47
|
- section-index # clickable sections leading to index page (https://github.com/oprypin/mkdocs-section-index)
|
|
48
48
|
- glightbox # better image support
|
|
49
|
-
- macros
|
|
50
|
-
- include-markdown # include content of other markdown files
|
|
49
|
+
# - macros
|
|
50
|
+
# - include-markdown # include content of other markdown files
|
|
51
51
|
- literate-nav: # move nav out of mkdocs.yml
|
|
52
52
|
nav_file: SUMMARY.md
|
|
53
53
|
# implicit_index: true
|
|
@@ -56,6 +56,7 @@ plugins:
|
|
|
56
56
|
- gen-files: # https://github.com/oprypin/mkdocs-gen-files
|
|
57
57
|
scripts:
|
|
58
58
|
- docs/gen_pages.py # or any other name or path
|
|
59
|
+
- coverage
|
|
59
60
|
- mkdocstrings:
|
|
60
61
|
default_handler: python
|
|
61
62
|
handlers:
|
|
@@ -19,9 +19,9 @@ from .mksourceandresult import MkSourceAndResult
|
|
|
19
19
|
from .mkshields import MkShields
|
|
20
20
|
from .mkpage import MkPage
|
|
21
21
|
from .mkpageinclude import MkPageInclude
|
|
22
|
+
from .mkinstallguide import MkInstallGuide
|
|
22
23
|
|
|
23
24
|
from .classnodes.mkclassdiagram import MkClassDiagram
|
|
24
|
-
from .classnodes.mkbaseclasstable import MkBaseClassTable
|
|
25
25
|
from .classnodes.mkclasstable import MkClassTable
|
|
26
26
|
from .classnodes.mkclasspage import MkClassPage
|
|
27
27
|
|
|
@@ -49,7 +49,6 @@ __all__ = [
|
|
|
49
49
|
"MkClassDiagram",
|
|
50
50
|
"ConnectionBuilder",
|
|
51
51
|
"MkTable",
|
|
52
|
-
"MkBaseClassTable",
|
|
53
52
|
"MkClassTable",
|
|
54
53
|
"MkList",
|
|
55
54
|
"MkClassPage",
|
|
@@ -63,6 +62,7 @@ __all__ = [
|
|
|
63
62
|
"MkShields",
|
|
64
63
|
"MkPageInclude",
|
|
65
64
|
"MkCritic",
|
|
65
|
+
"MkInstallGuide",
|
|
66
66
|
]
|
|
67
67
|
|
|
68
|
-
__version__ = "0.
|
|
68
|
+
__version__ = "0.4.1"
|
|
@@ -5,12 +5,19 @@ import logging
|
|
|
5
5
|
import os
|
|
6
6
|
import pathlib
|
|
7
7
|
import re
|
|
8
|
+
|
|
9
|
+
from typing import TYPE_CHECKING
|
|
8
10
|
import urllib.parse
|
|
9
11
|
|
|
10
12
|
from mkdocs.plugins import BasePlugin
|
|
11
13
|
import mkdocs.utils
|
|
12
14
|
|
|
13
15
|
|
|
16
|
+
if TYPE_CHECKING:
|
|
17
|
+
from mkdocs.config.defaults import MkDocsConfig
|
|
18
|
+
from mkdocs.structure.files import Files
|
|
19
|
+
from mkdocs.structure.pages import Page
|
|
20
|
+
|
|
14
21
|
logger = logging.getLogger(f"mkdocs.plugins.{__name__}")
|
|
15
22
|
logger.addFilter(mkdocs.utils.warning_filter)
|
|
16
23
|
|
|
@@ -64,12 +71,21 @@ class AutoLinkReplacerPlugin:
|
|
|
64
71
|
|
|
65
72
|
|
|
66
73
|
class LinkReplacerPlugin(BasePlugin):
|
|
67
|
-
def on_page_markdown(
|
|
74
|
+
def on_page_markdown(
|
|
75
|
+
self,
|
|
76
|
+
markdown: str,
|
|
77
|
+
*,
|
|
78
|
+
page: Page,
|
|
79
|
+
config: MkDocsConfig,
|
|
80
|
+
files: Files,
|
|
81
|
+
) -> str | None:
|
|
68
82
|
base_docs_url = config["docs_dir"]
|
|
69
83
|
page_url = page.file.src_path
|
|
70
84
|
mapping = collections.defaultdict(list)
|
|
71
85
|
for file_ in files:
|
|
72
86
|
filename = os.path.basename(file_.abs_src_path) # noqa: PTH119
|
|
73
87
|
mapping[filename].append(file_.url)
|
|
88
|
+
# print(file_.url, file_.dest_uri)
|
|
89
|
+
# raise ValueError
|
|
74
90
|
plugin = AutoLinkReplacerPlugin(base_docs_url, page_url, mapping)
|
|
75
91
|
return re.sub(AUTOLINK_RE, plugin, markdown)
|
|
@@ -71,7 +71,7 @@ class MkClassPage(mkpage.MkPage):
|
|
|
71
71
|
path = f"{module_path}.{self.klass.__name__}"
|
|
72
72
|
item = mkdocstrings.MkDocStrings(path, header="DocStrings")
|
|
73
73
|
self.append(item)
|
|
74
|
-
if tbl := mkclasstable.MkClassTable(self.klass):
|
|
74
|
+
if tbl := mkclasstable.MkClassTable(list(self.klass.__bases__)):
|
|
75
75
|
self.append(tbl)
|
|
76
76
|
item = mkclassdiagram.MkClassDiagram(self.klass, header="Inheritance diagram")
|
|
77
77
|
self.append(item)
|
|
@@ -12,12 +12,12 @@ from mknodes.utils import helpers
|
|
|
12
12
|
logger = logging.getLogger(__name__)
|
|
13
13
|
|
|
14
14
|
|
|
15
|
-
class
|
|
15
|
+
class MkClassTable(mktable.MkTable):
|
|
16
16
|
"""Table showing info for a list of classes."""
|
|
17
17
|
|
|
18
18
|
def __init__(
|
|
19
19
|
self,
|
|
20
|
-
klasses: list[type],
|
|
20
|
+
klasses: list[type] | set[type],
|
|
21
21
|
*,
|
|
22
22
|
layout: Literal["compact", "extended"] = "extended",
|
|
23
23
|
filter_fn: Callable | None = None,
|
|
@@ -51,9 +51,9 @@ class MkBaseClassTable(mktable.MkTable):
|
|
|
51
51
|
def examples():
|
|
52
52
|
from mknodes import mknav
|
|
53
53
|
|
|
54
|
-
yield dict(klasses=[mktable.MkTable,
|
|
54
|
+
yield dict(klasses=[mktable.MkTable, MkClassTable, mknav.MkNav])
|
|
55
55
|
yield dict(
|
|
56
|
-
klasses=[mktable.MkTable,
|
|
56
|
+
klasses=[mktable.MkTable, MkClassTable, mknav.MkNav],
|
|
57
57
|
layout="extended",
|
|
58
58
|
)
|
|
59
59
|
|
|
@@ -95,5 +95,5 @@ class MkBaseClassTable(mktable.MkTable):
|
|
|
95
95
|
|
|
96
96
|
|
|
97
97
|
if __name__ == "__main__":
|
|
98
|
-
table =
|
|
98
|
+
table = MkClassTable(klasses=[mktable.MkTable], layout="extended")
|
|
99
99
|
print(table)
|
|
@@ -23,9 +23,6 @@ def create_page_2(root_nav: mknodes.MkNav):
|
|
|
23
23
|
# Each Documentation section can have global filters for what it should include.
|
|
24
24
|
# In this case, we only want to document stuff which is listed in "__all__".
|
|
25
25
|
mknodes_docs = doc_section.add_doc(module=mknodes, filter_by___all__=True)
|
|
26
|
-
# we start by adding a nice overview page. This might gain some kwargs for different
|
|
27
|
-
# styles in the future.
|
|
28
|
-
mknodes_docs.add_module_overview()
|
|
29
26
|
|
|
30
27
|
# the Documentation Nav hast some helper methods to iterate through the submodules
|
|
31
28
|
# / classes of a module. We can also pass a predicate to filter specific subclasses,
|
|
@@ -41,7 +38,6 @@ def create_page_2(root_nav: mknodes.MkNav):
|
|
|
41
38
|
for stdlib_mod in ["pathlib", "inspect", "logging"]:
|
|
42
39
|
docs = std_lib_nav.add_doc(module=stdlib_mod)
|
|
43
40
|
docs.collect_classes(recursive=True)
|
|
44
|
-
docs.add_module_overview()
|
|
45
41
|
|
|
46
42
|
overview.add_admonition(text="That was easy, right?")
|
|
47
43
|
|
|
@@ -28,6 +28,9 @@ class MkDoc(mknav.MkNav):
|
|
|
28
28
|
filter_by___all__: Whether to filter stuff according to "__all__"
|
|
29
29
|
exclude_modules: List of modules to exclude
|
|
30
30
|
section_name: Optional section name override
|
|
31
|
+
class_page: Override for the default ClassPage
|
|
32
|
+
(default: [MkClassPage](MkClassPage.md))
|
|
33
|
+
flatten_nav: Whether classes should be put into top-level of the nav
|
|
31
34
|
"""
|
|
32
35
|
|
|
33
36
|
def __init__(
|
|
@@ -65,6 +68,7 @@ class MkDoc(mknav.MkNav):
|
|
|
65
68
|
)
|
|
66
69
|
|
|
67
70
|
def to_markdown(self) -> str:
|
|
71
|
+
self.add_module_overview()
|
|
68
72
|
for klass in self.klasses:
|
|
69
73
|
self.add_class_page(klass=klass, flatten=self.flatten_nav)
|
|
70
74
|
for submod in self.submodules:
|
|
@@ -234,6 +238,7 @@ class MkDoc(mknav.MkNav):
|
|
|
234
238
|
page = mkmodulepage.MkModulePage(
|
|
235
239
|
hide_toc=True,
|
|
236
240
|
module=self.module,
|
|
241
|
+
klasses=self.klasses,
|
|
237
242
|
path=path,
|
|
238
243
|
parent=self,
|
|
239
244
|
**kwargs,
|
|
@@ -7,14 +7,14 @@ import types
|
|
|
7
7
|
|
|
8
8
|
from typing import Any, Literal
|
|
9
9
|
|
|
10
|
-
from mknodes import
|
|
10
|
+
from mknodes import mknode
|
|
11
11
|
from mknodes.utils import classhelpers, helpers
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
logger = logging.getLogger(__name__)
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
class MkDocStrings(
|
|
17
|
+
class MkDocStrings(mknode.MkNode):
|
|
18
18
|
"""Docstring section (powered by mkdocstrings)."""
|
|
19
19
|
|
|
20
20
|
REQUIRED_PLUGINS = "mkdocstrings"
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import logging
|
|
4
|
+
|
|
5
|
+
from mknodes import mknode
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
logger = logging.getLogger(__name__)
|
|
9
|
+
|
|
10
|
+
TEXT = """The latest released version is available at the [Python
|
|
11
|
+
package index](https://pypi.org/project/{project}).
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
pip install {project}
|
|
15
|
+
```
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
class MkInstallGuide(mknode.MkNode):
|
|
20
|
+
"""Install guide text (currently PyPi only)."""
|
|
21
|
+
|
|
22
|
+
def __init__(
|
|
23
|
+
self,
|
|
24
|
+
project: str,
|
|
25
|
+
**kwargs,
|
|
26
|
+
):
|
|
27
|
+
super().__init__(**kwargs)
|
|
28
|
+
self.project = project
|
|
29
|
+
|
|
30
|
+
def _to_markdown(self) -> str:
|
|
31
|
+
return TEXT.format(project=self.project)
|
|
32
|
+
|
|
33
|
+
@staticmethod
|
|
34
|
+
def examples():
|
|
35
|
+
yield dict(project="mknodes")
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
if __name__ == "__main__":
|
|
39
|
+
installguide = MkInstallGuide(project="mknodes")
|
|
40
|
+
print(installguide)
|
|
@@ -86,6 +86,7 @@ class MkNode(node.Node):
|
|
|
86
86
|
|
|
87
87
|
@property
|
|
88
88
|
def resolved_virtual_files(self) -> dict[str, str | bytes]:
|
|
89
|
+
"""Return a dict containing all virtual files with resolved file paths."""
|
|
89
90
|
from mknodes import mknav
|
|
90
91
|
|
|
91
92
|
sections = [i.section for i in self.ancestors if isinstance(i, mknav.MkNav)]
|
|
@@ -109,6 +110,11 @@ class MkNode(node.Node):
|
|
|
109
110
|
return all_files
|
|
110
111
|
|
|
111
112
|
def write(self, only_children: bool = False):
|
|
113
|
+
"""Write files to virtual folder.
|
|
114
|
+
|
|
115
|
+
Arguments:
|
|
116
|
+
only_children: Whether to exclude self for data.
|
|
117
|
+
"""
|
|
112
118
|
# path = pathlib.Path(self.path)
|
|
113
119
|
# path.parent.mkdir(parents=True, exist_ok=True)
|
|
114
120
|
for k, v in self.all_virtual_files(only_children=only_children).items():
|
|
@@ -5,7 +5,7 @@ import logging
|
|
|
5
5
|
|
|
6
6
|
from typing import Literal
|
|
7
7
|
|
|
8
|
-
from mknodes import
|
|
8
|
+
from mknodes import mknode
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
logger = logging.getLogger(__name__)
|
|
@@ -103,7 +103,7 @@ ShieldTypeStr = Literal[
|
|
|
103
103
|
]
|
|
104
104
|
|
|
105
105
|
|
|
106
|
-
class MkShields(
|
|
106
|
+
class MkShields(mknode.MkNode):
|
|
107
107
|
"""MkCritic block."""
|
|
108
108
|
|
|
109
109
|
def __init__(
|
|
@@ -138,9 +138,9 @@ class MkShields(mktext.MkText):
|
|
|
138
138
|
|
|
139
139
|
|
|
140
140
|
if __name__ == "__main__":
|
|
141
|
-
|
|
141
|
+
shields = MkShields(
|
|
142
142
|
shields=["version", "status", "codecov"],
|
|
143
143
|
user="phil65",
|
|
144
144
|
project="prettyqt",
|
|
145
145
|
)
|
|
146
|
-
print(
|
|
146
|
+
print(shields)
|
|
@@ -6,7 +6,7 @@ import pathlib
|
|
|
6
6
|
import types
|
|
7
7
|
|
|
8
8
|
from mknodes import mkdocstrings, mkpage
|
|
9
|
-
from mknodes.classnodes import
|
|
9
|
+
from mknodes.classnodes import mkclasstable
|
|
10
10
|
from mknodes.utils import classhelpers, helpers
|
|
11
11
|
|
|
12
12
|
|
|
@@ -27,6 +27,7 @@ class MkModulePage(mkpage.MkPage):
|
|
|
27
27
|
self,
|
|
28
28
|
module: tuple[str, ...] | str | types.ModuleType,
|
|
29
29
|
*,
|
|
30
|
+
klasses: list[type] | set[type] | None = None,
|
|
30
31
|
path: str | os.PathLike = "index.md",
|
|
31
32
|
docstrings: bool = False,
|
|
32
33
|
show_class_table: bool = True,
|
|
@@ -37,6 +38,9 @@ class MkModulePage(mkpage.MkPage):
|
|
|
37
38
|
self.parts = classhelpers.to_module_parts(module)
|
|
38
39
|
self.module = classhelpers.to_module(module)
|
|
39
40
|
self.docstrings = docstrings
|
|
41
|
+
self.klasses = klasses or list(
|
|
42
|
+
classhelpers.iter_classes(module=self.parts, module_filter=self.parts[0]),
|
|
43
|
+
)
|
|
40
44
|
self.show_class_table = show_class_table
|
|
41
45
|
self._build()
|
|
42
46
|
|
|
@@ -56,10 +60,7 @@ class MkModulePage(mkpage.MkPage):
|
|
|
56
60
|
item = mkdocstrings.MkDocStrings(f'{".".join(self.parts)}')
|
|
57
61
|
self.append(item)
|
|
58
62
|
if self.show_class_table:
|
|
59
|
-
|
|
60
|
-
classhelpers.iter_classes(module=self.parts, module_filter=self.parts[0]),
|
|
61
|
-
)
|
|
62
|
-
table = mkbaseclasstable.MkBaseClassTable(klasses)
|
|
63
|
+
table = mkclasstable.MkClassTable(self.klasses)
|
|
63
64
|
self.append(table)
|
|
64
65
|
|
|
65
66
|
|
|
@@ -107,7 +107,7 @@ def to_module_parts( # type: ignore
|
|
|
107
107
|
|
|
108
108
|
|
|
109
109
|
def iter_classes(
|
|
110
|
-
module: types.ModuleType | str | tuple[str],
|
|
110
|
+
module: types.ModuleType | str | tuple[str, ...],
|
|
111
111
|
*,
|
|
112
112
|
type_filter: type | None | types.UnionType = None,
|
|
113
113
|
module_filter: str | None = None,
|
|
@@ -13,12 +13,12 @@ logger = logging.getLogger(__name__)
|
|
|
13
13
|
|
|
14
14
|
class InventoryManager:
|
|
15
15
|
def __init__(self):
|
|
16
|
-
self.inv_files:
|
|
16
|
+
self.inv_files: list[inventory.Inventory] = list()
|
|
17
17
|
|
|
18
18
|
def add_inv_file(self, path: str | os.PathLike):
|
|
19
19
|
with pathlib.Path(path).open("rb") as file:
|
|
20
20
|
inv = inventory.Inventory.parse_sphinx(file)
|
|
21
|
-
self.inv_files.
|
|
21
|
+
self.inv_files.append(inv)
|
|
22
22
|
|
|
23
23
|
def __getitem__(self, name: str | type | types.FunctionType | types.MethodType):
|
|
24
24
|
match name:
|
|
@@ -36,3 +36,6 @@ class InventoryManager:
|
|
|
36
36
|
|
|
37
37
|
if __name__ == "__main__":
|
|
38
38
|
inv_manager = InventoryManager()
|
|
39
|
+
inv_manager.add_inv_file("mknodes/utils/objects.inv")
|
|
40
|
+
file = inv_manager.inv_files[0]
|
|
41
|
+
print(file.keys())
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from importlib import metadata
|
|
4
|
+
import logging
|
|
5
|
+
import os
|
|
6
|
+
import sys
|
|
7
|
+
|
|
8
|
+
from mknodes.utils import helpers, inventorymanager
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
logger = logging.getLogger(__name__)
|
|
12
|
+
|
|
13
|
+
BUILTIN_URL = "https://docs.python.org/3/library/{mod}.html#{name}"
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
class LinkProvider:
|
|
17
|
+
def __init__(self):
|
|
18
|
+
self.inv_manager = inventorymanager.InventoryManager()
|
|
19
|
+
|
|
20
|
+
def add_inv_file(self, path: str | os.PathLike):
|
|
21
|
+
self.inv_manager.add_inv_file(path)
|
|
22
|
+
|
|
23
|
+
def link_for_klass(self, kls: type):
|
|
24
|
+
if kls.__module__ == "builtins":
|
|
25
|
+
url = BUILTIN_URL.format(mod="functions", name=kls.__name__)
|
|
26
|
+
return helpers.linked(url, title=kls.__name__)
|
|
27
|
+
if kls.__module__ in sys.stdlib_module_names:
|
|
28
|
+
mod = kls.__module__
|
|
29
|
+
url = BUILTIN_URL.format(mod=mod, name=f"{mod}.{kls.__name__}")
|
|
30
|
+
return helpers.linked(url, title=kls.__name__)
|
|
31
|
+
try:
|
|
32
|
+
dist = metadata.distribution(kls.__module__.split(".")[0])
|
|
33
|
+
except metadata.PackageNotFoundError:
|
|
34
|
+
return helpers.linked(kls.__qualname__)
|
|
35
|
+
else:
|
|
36
|
+
if url := dist.metadata["Home-Page"]:
|
|
37
|
+
return helpers.linked(url, title=kls.__qualname__)
|
|
38
|
+
return helpers.linked(kls.__qualname__)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
if __name__ == "__main__":
|
|
42
|
+
provider = LinkProvider()
|
|
43
|
+
link = provider.link_for_klass(logging.LogRecord)
|
|
44
|
+
print(link)
|
|
@@ -8,9 +8,6 @@ source = "regex_commit"
|
|
|
8
8
|
commit_extra_args = ["-e"]
|
|
9
9
|
path = "mknodes/__init__.py"
|
|
10
10
|
|
|
11
|
-
[project.entry-points."mkdocs.plugins"]
|
|
12
|
-
linkreplacer = "mknodes.__linkreplacer:LinkReplacerPlugin"
|
|
13
|
-
|
|
14
11
|
[tool.hatch.envs.default]
|
|
15
12
|
python = "3.10"
|
|
16
13
|
dependencies = [
|
|
@@ -24,12 +21,14 @@ dependencies = [
|
|
|
24
21
|
"mkdocstrings[python]",
|
|
25
22
|
"pymdown-extensions",
|
|
26
23
|
"mkdocs-literate-nav",
|
|
27
|
-
"mkdocs-include-markdown-plugin",
|
|
24
|
+
# "mkdocs-include-markdown-plugin",
|
|
28
25
|
# "mkdocs-autorefs",
|
|
29
26
|
"mkdocs-glightbox",
|
|
30
27
|
"mkdocs-section-index",
|
|
31
28
|
"mkdocs-gen-files",
|
|
32
|
-
"mkdocs-macros-plugin",
|
|
29
|
+
# "mkdocs-macros-plugin",
|
|
30
|
+
"markdown-exec[ansi]",
|
|
31
|
+
"mkdocs-coverage",
|
|
33
32
|
"pygments",
|
|
34
33
|
"typing_extensions",
|
|
35
34
|
]
|
|
@@ -63,14 +62,38 @@ description = "Generate docs with ease."
|
|
|
63
62
|
readme = "README.md"
|
|
64
63
|
dynamic = ["version"]
|
|
65
64
|
classifiers = [
|
|
65
|
+
"Development Status :: 4 - Beta",
|
|
66
|
+
"Intended Audience :: Developers",
|
|
67
|
+
"License :: OSI Approved :: MIT License",
|
|
68
|
+
"Operating System :: OS Independent",
|
|
69
|
+
"Programming Language :: Python :: 3",
|
|
66
70
|
"Programming Language :: Python :: 3 :: Only",
|
|
71
|
+
"Programming Language :: Python :: 3.10",
|
|
72
|
+
"Programming Language :: Python :: 3.11",
|
|
73
|
+
"Topic :: Documentation",
|
|
74
|
+
"Topic :: Internet",
|
|
75
|
+
"Topic :: Text Processing :: Markup :: Markdown",
|
|
67
76
|
]
|
|
77
|
+
keywords = [
|
|
78
|
+
"framework",
|
|
79
|
+
"docs",
|
|
80
|
+
"docstrings",
|
|
81
|
+
"documentation",
|
|
82
|
+
"internet",
|
|
83
|
+
"markdown",
|
|
84
|
+
]
|
|
85
|
+
|
|
68
86
|
requires-python = ">=3.10"
|
|
69
87
|
dependencies = [
|
|
70
88
|
"typing_extensions",
|
|
71
89
|
"mkdocs-gen-files",
|
|
72
90
|
"mkdocs",
|
|
73
91
|
]
|
|
92
|
+
license = "MIT"
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
[project.entry-points."mkdocs.plugins"]
|
|
96
|
+
linkreplacer = "mknodes.__linkreplacer:LinkReplacerPlugin"
|
|
74
97
|
|
|
75
98
|
[project.urls]
|
|
76
99
|
Documentation = "https://phil65.github.io/mknodes/"
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
from __future__ import annotations
|
|
2
|
-
|
|
3
|
-
from collections.abc import Callable
|
|
4
|
-
import logging
|
|
5
|
-
|
|
6
|
-
from typing import Literal
|
|
7
|
-
|
|
8
|
-
from mknodes.classnodes import mkbaseclasstable
|
|
9
|
-
from mknodes.utils import helpers
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
logger = logging.getLogger(__name__)
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
class MkClassTable(mkbaseclasstable.MkBaseClassTable):
|
|
16
|
-
"""Table to show information about a specific class."""
|
|
17
|
-
|
|
18
|
-
def __init__(
|
|
19
|
-
self,
|
|
20
|
-
klass: type,
|
|
21
|
-
*,
|
|
22
|
-
layout: Literal["compact", "extended"] = "extended",
|
|
23
|
-
filter_fn: Callable | None = None,
|
|
24
|
-
mode: Literal["sub_classes", "parent_classes"] = "sub_classes",
|
|
25
|
-
**kwargs,
|
|
26
|
-
):
|
|
27
|
-
self.mode = mode
|
|
28
|
-
self.klass = klass
|
|
29
|
-
match self.mode:
|
|
30
|
-
case "sub_classes":
|
|
31
|
-
try:
|
|
32
|
-
klasses = klass.__subclasses__()
|
|
33
|
-
except TypeError:
|
|
34
|
-
klasses = []
|
|
35
|
-
case "parent_classes":
|
|
36
|
-
klasses = list(klass.__bases__)
|
|
37
|
-
case _:
|
|
38
|
-
raise ValueError(self.mode)
|
|
39
|
-
super().__init__(klasses=klasses, layout=layout, filter_fn=filter_fn, **kwargs)
|
|
40
|
-
|
|
41
|
-
def __repr__(self):
|
|
42
|
-
return helpers.get_repr(
|
|
43
|
-
self,
|
|
44
|
-
klass=self.klass,
|
|
45
|
-
mode=self.mode,
|
|
46
|
-
)
|
|
47
|
-
|
|
48
|
-
@staticmethod
|
|
49
|
-
def examples():
|
|
50
|
-
from mknodes import mknav
|
|
51
|
-
|
|
52
|
-
yield dict(klass=mknav.MkNav)
|
|
53
|
-
yield dict(klass=mknav.MkNav, mode="parent_classes")
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
if __name__ == "__main__":
|
|
57
|
-
table = MkClassTable(klass=MkClassTable, layout="extended")
|
|
58
|
-
print(table)
|
|
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
|
|
File without changes
|
|
File without changes
|
|
File without changes
|