Mkdocs plugin to generate documentation from clingo files
Project description
mkdoclingo
mkdoclingo is an automated documentation tool tailored for Answer Set Programming (ASP) code. Built on MkDocs and mkdocs-material, it streamlines the creation of high-quality documentation with the following features:
- Render encodings: Automatically format ASP encodings with comments written in Markdown.
- Predicate analysis: Collect and document predicates used across included files.
- Navigation-friendly documentation: Generate organized predicate documentation with intuitive navigation.
- Input/output identification: Detect and highlight input and output predicates.
- Dependency graphs: Visualize dependencies between predicates and files.
For installation instructions and detailed usage, visit our official documentation.
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
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 mkdoclingo-1.0.4.tar.gz.
File metadata
- Download URL: mkdoclingo-1.0.4.tar.gz
- Upload date:
- Size: 169.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4538552155820add22f613e9116455a875e648e9eb50eceeba73790ac51414d4
|
|
| MD5 |
d36d771c86a3fb1be9b8520d1a5c84ca
|
|
| BLAKE2b-256 |
dc5c1cb7fd63b3c53553913f8a03b63d8c3a36006d5693a74a38c09bda060c2c
|
Provenance
The following attestation bundles were made for mkdoclingo-1.0.4.tar.gz:
Publisher:
deploy.yml on potassco/mkdoclingo
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdoclingo-1.0.4.tar.gz -
Subject digest:
4538552155820add22f613e9116455a875e648e9eb50eceeba73790ac51414d4 - Sigstore transparency entry: 214021506
- Sigstore integration time:
-
Permalink:
potassco/mkdoclingo@39736a13b247b335a89a822f13cae8130f5face2 -
Branch / Tag:
refs/tags/v1.0.4 - Owner: https://github.com/potassco
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy.yml@39736a13b247b335a89a822f13cae8130f5face2 -
Trigger Event:
push
-
Statement type:
File details
Details for the file mkdoclingo-1.0.4-py3-none-any.whl.
File metadata
- Download URL: mkdoclingo-1.0.4-py3-none-any.whl
- Upload date:
- Size: 121.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
98b4fbad38f01276d355a53df4c5cb0a9ccc7d0553b0a8bd729b23eb961b8bc2
|
|
| MD5 |
4832aa68ca178b122ca6cdb42ac4e239
|
|
| BLAKE2b-256 |
853ffdf0322516a91669a0ce1e51be0ebbe06ea22f2ca3c0c40bc49f74209feb
|
Provenance
The following attestation bundles were made for mkdoclingo-1.0.4-py3-none-any.whl:
Publisher:
deploy.yml on potassco/mkdoclingo
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdoclingo-1.0.4-py3-none-any.whl -
Subject digest:
98b4fbad38f01276d355a53df4c5cb0a9ccc7d0553b0a8bd729b23eb961b8bc2 - Sigstore transparency entry: 214021522
- Sigstore integration time:
-
Permalink:
potassco/mkdoclingo@39736a13b247b335a89a822f13cae8130f5face2 -
Branch / Tag:
refs/tags/v1.0.4 - Owner: https://github.com/potassco
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy.yml@39736a13b247b335a89a822f13cae8130f5face2 -
Trigger Event:
push
-
Statement type: