MkDefaultWebsite

Base classes | Name | Children | Inherits | |--- | --- | --- | | MkNav
mknodes.navs.mknav
Nav section, representing a nestable menu. |

| |

⋔ Inheritance diagram 

graph TD
  94079155022016["mkdefaultwebsite.MkDefaultWebsite"]
  94079154092016["mknav.MkNav"]
  94079153899248["mknode.MkNode"]
  94079153762432["node.Node"]
  139736964773184["builtins.object"]
  94079154092016 --> 94079155022016
  94079153899248 --> 94079154092016
  94079153762432 --> 94079153899248
  139736964773184 --> 94079153762432

🛈 DocStrings

Bases: MkNav

Nav for showing a default website including API docs and environment infos.

Source code in mkdocs_mknodes/mkdefaultwebsite.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
class MkDefaultWebsite(mk.MkNav):
    """Nav for showing a default website including API docs and environment infos."""

    def __init__(
        self,
        static_pages: dict[str, str | dict | list] | None = None,
        **kwargs: Any,
    ):
        super().__init__(**kwargs)

        page = self.add_page(is_index=True, hide="toc")
        page += mk.MkText(page.ctx.metadata.description)
        static_pages = static_pages or {}
        self.parse.json(static_pages)
        self.add_doc(section_name="API", recursive=True)
        self.page_template.announcement_bar = mk.MkMetadataBadges("websites")
        if self.ctx.metadata.cli:
            page = self.add_page("CLI", hide="nav")
            page += mk.MkCliDoc(show_subcommands=True)

        nav = self.add_nav("Development")

        page = nav.add_page("Changelog")
        page += mk.MkChangelog()

        page = nav.add_page("Code of conduct")
        page += mk.MkCodeOfConduct()

        page = nav.add_page("Contributing")
        page += mk.MkCommitConventions()
        page += mk.MkPullRequestGuidelines()

        page = nav.add_page("Setting up the environment")
        page += mk.MkDevEnvSetup()
        page += mk.MkDevTools(header="Tools")

        page = nav.add_page("Dependencies")
        page += mk.MkDependencyTable()
        page += mk.MkPipDepTree(direction="LR")

        if "mkdocs.plugins" in self.ctx.metadata.entry_points:
            page = nav.add_page("MkDocs Plugins")
            page += mk.MkPluginFlow()

        node = mk.MkLicense()
        page = nav.add_page("License", hide="toc")
        page += node

Show source on GitHub