Don't write docs. Code them.
Project description
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
MkNodes (Mkdocs Plugin)
Don't write docs. Code them.
Read the completely coded documentation!
How to install
pip
The latest released version is available at the Python package index.
pip install mkdocs-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
mkdocs_mknodes-0.6.2.tar.gz
(289.0 kB
view details)
Built Distribution
File details
Details for the file mkdocs_mknodes-0.6.2.tar.gz
.
File metadata
- Download URL: mkdocs_mknodes-0.6.2.tar.gz
- Upload date:
- Size: 289.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3065fe354c0442ab0d5ad3aa947db2dc6a61b1160ae3f14aed47c341e97fbee5 |
|
MD5 | 2f76a3bab5f26dc48eb172db7249f086 |
|
BLAKE2b-256 | 5e96306690e8bdce3a48816216997d8a9bf4f2dfe6dc10b9a280fdcc5b970036 |
File details
Details for the file mkdocs_mknodes-0.6.2-py3-none-any.whl
.
File metadata
- Download URL: mkdocs_mknodes-0.6.2-py3-none-any.whl
- Upload date:
- Size: 63.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ee1dd57e34ea25d79a270485504daa7974d7223c889bf741098c1e9eb02756b |
|
MD5 | 40df9a2f14ba39abbed5a13f681dc0e9 |
|
BLAKE2b-256 | 64b2596afa2cb2f7f37cc9fb081ce00369baf082e84b8fc059e44ca42c4217a2 |