Skip to main content

Mkdocs plugin to generate documentation from clingo files

Project description

clindocs

clindocs 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

clindocs-1.5.2.tar.gz (92.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clindocs-1.5.2-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

Details for the file clindocs-1.5.2.tar.gz.

File metadata

  • Download URL: clindocs-1.5.2.tar.gz
  • Upload date:
  • Size: 92.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for clindocs-1.5.2.tar.gz
Algorithm Hash digest
SHA256 ac78e80e7ca7aa3f2cfcd1e13a400bfa103090410d4b7d44436929333b31d92a
MD5 dc97884b2f0bfa51e169b4ba8e946e21
BLAKE2b-256 0aa40628a770561650b5a60d07af6b77b2c5d5019876bd068e717ab3e21e2cf9

See more details on using hashes here.

Provenance

The following attestation bundles were made for clindocs-1.5.2.tar.gz:

Publisher: deploy.yml on potassco/clindocs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file clindocs-1.5.2-py3-none-any.whl.

File metadata

  • Download URL: clindocs-1.5.2-py3-none-any.whl
  • Upload date:
  • Size: 35.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for clindocs-1.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b88d048ad44772fcb7ba6c432b22ae673b8b24c390673e56240041fc12dab83c
MD5 e7834e7e84c098bb151ea7f9fb48863a
BLAKE2b-256 700989b32a7c20f7b5d1d11e897722ad25a460c6590eb87e1af640c44897f4ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for clindocs-1.5.2-py3-none-any.whl:

Publisher: deploy.yml on potassco/clindocs

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