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.0.6.tar.gz (170.5 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.0.6-py3-none-any.whl (121.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdoclingo-1.0.6.tar.gz
Algorithm Hash digest
SHA256 8afb3c1b617b4a97d1fd8cc38d46385932c0b39bd39c2993df13aa57bb8bc741
MD5 d21aebc1daa42809ff69159ccc126d22
BLAKE2b-256 4dc1c04bfd5009a4028dc540b94a674fd751e1eed18a1b7eaf6994c4d9dd733d

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: mkdoclingo-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 121.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.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c6af7e3b8995ae2a7ed01d4e538f05e6c131217faa6958ea45b83d7a5346513d
MD5 8d92c41b682a03bd2388bf657dbcdac2
BLAKE2b-256 7727cf19b2c2e1ada8d8ac7c5ed3ab6b3fd3321af1218a7f12454ed0537dadbe

See more details on using hashes here.

Provenance

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