Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdoclingo-1.4.0.tar.gz (88.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdoclingo-1.4.0-py3-none-any.whl (34.1 kB view details)

Uploaded Python 3

File details

Details for the file mkdoclingo-1.4.0.tar.gz.

File metadata

  • Download URL: mkdoclingo-1.4.0.tar.gz
  • Upload date:
  • Size: 88.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mkdoclingo-1.4.0.tar.gz
Algorithm Hash digest
SHA256 75321613c90206a283157165fc40f293652c6f6893fffd4ada3f8f85cc0f35ad
MD5 362f74c9337d404cb4c4b918d9499e08
BLAKE2b-256 265245b25ea7dbd103b1ebf954d2e76b3b41f6f0cd39a0b13eb9b49ed6bdcddf

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdoclingo-1.4.0.tar.gz:

Publisher: deploy.yml on potassco/mkdoclingo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdoclingo-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: mkdoclingo-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 34.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mkdoclingo-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 60f0605018a0335a0c998acca6bbb0e46e9310a4d8ff158ae2733bc52521c0a3
MD5 011f80fad5233f317ddb8ec7b53a8613
BLAKE2b-256 87492bffcb2f52f367508079b9cffabe7a3192fab9118f1032ad7361c3dda391

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdoclingo-1.4.0-py3-none-any.whl:

Publisher: deploy.yml on potassco/mkdoclingo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page