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-0.2.0.tar.gz (89.0 kB view details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdoclingo-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c10b0ad780d53ece55f6eae72b566f95f8c67d2aa96fb7fe171efbd6081f434f
MD5 6660fa06cb38adc6c5a05c0740216126
BLAKE2b-256 1ff5ba382ffc23e68caf0346be165f4f01d8c43c033110b2dcb069f8298cda4b

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: mkdoclingo-0.2.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-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 02d91d2e78dfd5e4a1f9aa4e26182cfad9376d9c6cc30672900b7e24875e7ce0
MD5 be33730aa0cd4b88e0a1ee8140f55b3c
BLAKE2b-256 a2843d44d45d6d3d8b5efcab698bc6ed9dd59aa7636e71939d5b01f1cff99fbb

See more details on using hashes here.

Provenance

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