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.4.tar.gz (169.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.0.4-py3-none-any.whl (121.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdoclingo-1.0.4.tar.gz
  • Upload date:
  • Size: 169.9 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.4.tar.gz
Algorithm Hash digest
SHA256 4538552155820add22f613e9116455a875e648e9eb50eceeba73790ac51414d4
MD5 d36d771c86a3fb1be9b8520d1a5c84ca
BLAKE2b-256 dc5c1cb7fd63b3c53553913f8a03b63d8c3a36006d5693a74a38c09bda060c2c

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: mkdoclingo-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 121.1 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 98b4fbad38f01276d355a53df4c5cb0a9ccc7d0553b0a8bd729b23eb961b8bc2
MD5 4832aa68ca178b122ca6cdb42ac4e239
BLAKE2b-256 853ffdf0322516a91669a0ce1e51be0ebbe06ea22f2ca3c0c40bc49f74209feb

See more details on using hashes here.

Provenance

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