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.3.0.tar.gz (172.3 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.3.0-py3-none-any.whl (122.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdoclingo-1.3.0.tar.gz
Algorithm Hash digest
SHA256 9332ed766fe0e7079cc8a26142deff0bcc30f5ab0e7dea5031f4d331fd56231c
MD5 f7c6d5dfdb1a52443bf47ff35aeb46c4
BLAKE2b-256 46a3a8142633294070819b50f441f6fbf02e21c9a6af9289454a0107a71ba703

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdoclingo-1.3.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.3.0-py3-none-any.whl.

File metadata

  • Download URL: mkdoclingo-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 122.7 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8156e5419eb8515d11e3be993cf68c1d3050a15fd4246771044f93ac56227086
MD5 01b04ad2989008eb1ad0419ea445dd11
BLAKE2b-256 ef2e2b57ad85209a6f3381227415bae835bf8f4389cb51457e63dd82f7ce69e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdoclingo-1.3.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