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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdoclingo-1.0.5.tar.gz
  • Upload date:
  • Size: 170.4 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.5.tar.gz
Algorithm Hash digest
SHA256 3a06f1e535f8bdf96e8715490c196ff07202e12151a7ff06e66f54f6905ff315
MD5 b287f6f8173fa77a183be9ea458725fb
BLAKE2b-256 a914a897e83636a4b8e63fdb2911cafd058b58fbc3d53e824b549fbf8d5d03c1

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: mkdoclingo-1.0.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e43fbf9bdf19ff15a136fc77d4655a2b3176d42f59ab90eea18c11125b47e130
MD5 26f01bd0f9549509bb176cd677d7fb67
BLAKE2b-256 7e0c14b2d207b88737b48c31f7ddd2d401af9b2a486378d2c391fecde61b1d36

See more details on using hashes here.

Provenance

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