Glossary

Generates a glossary with detailed information of all predicates using their predicate documentation. See the predicate documentation section for more details.

Each predicate generates a section in the TOC.

Each predicate section includes the references for each file where the predicate was used.

Example

Output Usage

::: examples/sudoku/encoding.lp
    handler: asp
    options:
        glossary: true
        start_level: 3

Configuration options

The option glossary can be further customized with the following options:

• include_undocumented Boolean indicating if predicates that have no docstring should be included. Defaults to True.
• include_hidden Boolean indicating if predicates that are not shown nor input should be included. Defaults to True.
• include_references Boolean indicating if each predicate documentations should include a section with the references. Defaults to True.

Example

Output Usage

::: examples/sudoku/encoding.lp
    handler: asp
    options:
        glossary:
            include_references: false
        start_level: 3