Metadata-Version: 2.4
Name: mkdoclingo
Version: 1.0.3
Summary: Mkdocs plugin to generate documentation from clingo files
Author-email: Potassco <hahnmartinlu@uni-potsdam.de>
License: MIT License
        
        Copyright (c) 2024 Potassco
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/potassco/mkdoclingo.git/
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: clingo
Requires-Dist: mkdocstrings
Requires-Dist: tree-sitter
Requires-Dist: tomli; python_version < "3.11"
Provides-Extra: format
Requires-Dist: black; extra == "format"
Requires-Dist: isort; extra == "format"
Requires-Dist: autoflake; extra == "format"
Provides-Extra: lint-pylint
Requires-Dist: pylint; extra == "lint-pylint"
Provides-Extra: typecheck
Requires-Dist: types-setuptools; extra == "typecheck"
Requires-Dist: mypy; extra == "typecheck"
Provides-Extra: test
Requires-Dist: coverage[toml]; extra == "test"
Provides-Extra: doc
Requires-Dist: mkdocs; extra == "doc"
Requires-Dist: mkdocs-material; extra == "doc"
Requires-Dist: mkdocstrings[python]; extra == "doc"
Requires-Dist: tree-sitter; extra == "doc"
Requires-Dist: pygments_clingo; extra == "doc"
Provides-Extra: dev
Requires-Dist: mkdoclingo[lint_pylint,test,typecheck]; extra == "dev"
Dynamic: license-file

# mkdoclingo

## Installation

To install the project, run

```bash
pip install .
```

## Usage

Run the following for basic usage information:

```bash
mkdoclingo -h
```

To generate and open the documentation, run

```bash
nox -s doc -- serve
```

Instructions to install and use `nox` can be found in
[DEVELOPMENT.md](./DEVELOPMENT.md)

## How to use the Handler

1. Add this project to your dependencies

1. Add handler to `mkdocs.yml`

   ```yml
   plugins:
   - mkdocstrings:
       handlers:
           asp:
           paths: [encodings]
   ```

1. You may now use mkdocstrings identifiers like so:

   ```
   ::: some/path/to/encoding.lp
       handler: asp
   ```

## Options

The output is customizable via options.

For example:

```
::: some/path/to/encoding.lp
    handler: asp
    options:
        source: true
```

shows the source code of the corresponding encoding.

### Currently available options

- `source`: Source code of the encoding
- `dependency_graph`: Predicate dependency graph of the encoding
- `glossary`: Sorted information about predicates
