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.1.tar.gz (171.7 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.1-py3-none-any.whl (122.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdoclingo-1.1.1.tar.gz
  • Upload date:
  • Size: 171.7 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.1.tar.gz
Algorithm Hash digest
SHA256 1b41bb50128624314d022d2630fd36bb18469355a3f3613873228b23aa63f626
MD5 ed788c32a0cbed142f859448175e30cf
BLAKE2b-256 dac249782e3d9b9680345d33ee19658079292205917cbc2cbc275be6111532e6

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: mkdoclingo-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 122.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b8f6836664158e0cfa0496596e28a910d605350900644d4b76521b63190338c5
MD5 b7b6457195c5477d118179d31cbfa539
BLAKE2b-256 3138670edd5b1809c4be75c02559399b41e3380399b94a9660ce0ee5464a7543

See more details on using hashes here.

Provenance

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