Don't write docs. Code them.
Project description
MkNodes
Don't write docs. Code them.
Read the completely coded documentation!
Programatically create web pages
def create_github_index_md() -> mk.MkPage:
page = mk.MkPage("Github index")
page += mk.MkCode.for_object(create_github_index_md)
page += mk.MkHeader("MkNodes", level=1)
page += mk.MkHeader("Don't write docs. Code them.", level=4)
page += mk.MkShields()
page += mk.MkLink(DOC_URL, "Read the completely coded documentation!")
page += mk.MkInstallGuide(header="How to install")
page += mk.MkHeader("All the nodes!")
page += mk.MkClassDiagram(mk.MkNode, mode="subclasses", direction="LR")
return page
Create a website tree
@nav.route.page("Changelog", icon="format-list-group")
def _(page: mk.MkPage):
page += mk.MkChangelog()
Powerful templating
{{ "Inlined text" | MkAdmonition(inline="left") }}
How to install
pip
The latest released version is available at the Python package index.
pip install mknodes
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mknodes-0.52.11.tar.gz
(3.0 MB
view hashes)
Built Distribution
Close
Hashes for mknodes-0.52.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3eca9750a0168d1257ef775c6fcb2e71f4848bdd0f6ee09dbc919eee6df5f6b2 |
|
MD5 | 4a325b90a63cc526f7d326f38fb07795 |
|
BLAKE2b-256 | fa88b94a636e65f1b27f6ebdae71843700edae53e0e636dead1145b7c2a2c3a0 |