Skip to content

Glossary Summary

Basic Usage

To create a summary of all definitions and references for a glossary section, add a summary tag anywhere in your documentation:

# Terms and Definitions

<glossary::demo>

Example

Let's generate a summary for the section demo:

# Demo Terms

<glossary::demo>

This will produce the following summary, containing links to all definitions and references of terms in your documentation:

Output

my_term1
page_reference

Customizing Output

You can override the default behavior for list_definitions and list_references by adding modifiers to the glossary reference:

<glossary::demo|no_refs>

Note

When using modifiers in tables, you need to escape the | character:

| Column 1                  | Column 2 |
|---------------------------|----------|
| <glossary:demo\|no_refs> | ...      |

Available Modifiers

no_refs

Exclude reference links from the summary.

<glossary::demo|no_refs>

Output

my_term1
page_reference

no_defs

Exclude definitions from the summary.

<glossary::demo|no_defs>

Output

my_term1
page_reference

do_defs and do_refs

Explicitly include definitions and/or references.

<glossary::demo|do_defs+do_refs>

Output

my_term1
page_reference

Configuration

list_definitions
Controls whether definitions appear in the summary. Default is true.
plugins:
    - search
    - ezglossary:
        - list_definitions: false

plugins:
    - search
    - ezglossary:
        sections:
            demo
        section_config:
            - name: demo
              list_references = true

        - list_definitions: false
list_references
Controls whether references appear in the summary. Default is true.
plugins:
    - ezglossary:
        - list_references: false

plugins:
    - search
    - ezglossary:
        sections:
            demo
        section_config:
            - name: demo
              list_references = true

        - list_references: false

Themes

You can customize the summary appearance by passing a theme option:

<glossary::demo|theme=detailed>

The theme option loads a custom Jinja template named summary-<theme>.html.

Example

This theme shows the term definitions in the glossary:

Output

my_term1

Definition of my_term 1

page_reference

Page references

Available Themes

detailed
Displays the term definition in the summary.
table
Presents the summary in a tabular format.

Further Reading

  • See sections documentation for section configuration details.
  • Check customization for creating custom summary templates.