Was this page helpful?
Caution
You're viewing documentation for an unstable version of ScyllaDB Sphinx Theme. Switch to the latest stable version.
You can create a glossary using a paged named glossary.rst page.
The glossary has the following format:
.. glossary::
Term 1
Definition
Term 2
Definition
Long description
Lorem ipsum dolor sit amet, ``consectetur`` adipiscing elit. Ut tincidunt orci non pellentesque hendrerit. Sed vitae sem convallis, porta felis ut, varius libero. Suspendisse eget auctor felis. Sed sit amet sapien posuere, eleifend urna ut, interdum nisi.
Donec porta nibh leo, vitae convallis risus ornare sit amet. Mauris porttitor ipsum in mi dignissim, vel volutpat massa placerat.
Vivamus et cursus turpis, id luctus lectus.
This will result in:
Definition
Definition
Lorem ipsum dolor sit amet, consectetur
adipiscing elit. Ut tincidunt orci non pellentesque hendrerit. Sed vitae sem convallis, porta felis ut, varius libero. Suspendisse eget auctor felis. Sed sit amet sapien posuere, eleifend urna ut, interdum nisi.
Donec porta nibh leo, vitae convallis risus ornare sit amet. Mauris porttitor ipsum in mi dignissim, vel volutpat massa placerat.
Vivamus et cursus turpis, id luctus lectus.
The terms in the glossary are automatically organized in alphabetical order.
To reference a term from the glossary within other parts of your documentation, use the following convention:
:term:`term <term as written in Glossary>`
For exmaple:
:term:`Size-tiered Compaction Strategy (STCS)<Size-tiered Compaction Strategy>`
Abbreviations and acronyms are defined in-line, with the abbreviation followed by the full term in parentheses. Use the abbr role for this purpose:
:abbr:`LIFO (last-in, first-out)`
You can also use it for longer phrases:
:abbr:`Overwrite (Same data cells overwritten many times)`
Was this page helpful?