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
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-1.1.0a1.tar.gz
(48.6 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_mknodes-1.1.0a1.tar.gz.
File metadata
- Download URL: mkdocs_mknodes-1.1.0a1.tar.gz
- Upload date:
- Size: 48.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.15 {"installer":{"name":"uv","version":"0.9.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0bed31aa1414ac822f619e228567c64baebbd62384875538a9e93df581b33cb6
|
|
| MD5 |
ebd47f98af6ef25e7a0771d275e851ee
|
|
| BLAKE2b-256 |
8bdc32cf28600b5f7ee4e50401d6259e85b26272f8f7f88a783596954885a832
|
File details
Details for the file mkdocs_mknodes-1.1.0a1-py3-none-any.whl.
File metadata
- Download URL: mkdocs_mknodes-1.1.0a1-py3-none-any.whl
- Upload date:
- Size: 67.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.15 {"installer":{"name":"uv","version":"0.9.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8519d22d706cbebd0f1b33110a4675d89ef11ab0e959c6092c01d8e6b2ea8c2c
|
|
| MD5 |
967f205912bf0a0f6085a6cbb7041e26
|
|
| BLAKE2b-256 |
d6f1d7242ec15594f14b99059b23ccb8879b8fd56477c3ecb5c1de7ecf54bb1d
|
