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.1.0.tar.gz (171.6 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.1.0-py3-none-any.whl (122.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdoclingo-1.1.0.tar.gz
Algorithm Hash digest
SHA256 e22a78cafa28163be893889916a23e8bd30f6a6fd88760addd17af5221916420
MD5 c63fec8b1c97b2c18428230203791555
BLAKE2b-256 eeeb0094cc10dc87ed89574e82afad1fc1236cb5b5d567e975e63d394f75a0b5

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for mkdoclingo-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f30f9f7bd4ec24e8083a4e990cd8c80cfccecad531cc10683aa6ab28fcbe0aeb
MD5 ca5f53502b76b843b2bf9a9999d954a4
BLAKE2b-256 26acd7acbb5ece7e3a806fe056d561d27fb72a3b0d8104814039c1cd92c27750

See more details on using hashes here.

Provenance

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