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

Uploaded Python 3

File details

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

File metadata

  • Download URL: clindocs-1.5.1.tar.gz
  • Upload date:
  • Size: 92.2 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.1.tar.gz
Algorithm Hash digest
SHA256 2aff377275c1865e9cc08f4d896e7bac95b365605e0426b023506426fd5e075d
MD5 37f9d78fea67bcd912431082625e638e
BLAKE2b-256 e4aa27c9cea75911f147b14215ce3cb688553bfe20f263ae8fe83f9cf27dc040

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: clindocs-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 34.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 66f3812a19093726ea661415f21c1b20f394f4cb74ba8020e3b7bac39797fe86
MD5 65e9b2135730ca88df77a86476e1c3be
BLAKE2b-256 4c14c9968ee0012daaf18be45c2787c4d1f2448093784db7b694141869151029

See more details on using hashes here.

Provenance

The following attestation bundles were made for clindocs-1.5.1-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