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.46.11.tar.gz
(3.0 MB
view hashes)
Built Distribution
Close
Hashes for mknodes-0.46.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0acae934c1185cb25b31eb8df9ab823370d0ef95a3b16a196ef65519ebf802b5 |
|
MD5 | 9de831550dfdab0fc0b55c918d9085da |
|
BLAKE2b-256 | 14c197a8912d58ce0c52f3d151d60b405bc1eb1184b2f1581d8a97d882cdf472 |