.. _GLOSSARY:

Glossary
########

.. glossary::

   Badge
     See :term:`Shield`.

   Directive
     A `directive <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#directives>`__ is an explicit
     markup block of reStructuredText - ``.. name:: arguments`` with options and content - which an extension can
     add. Sphinx's `list of directives <https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html>`__
     shows the built-in ones.

   DOT
     The `graph description language <https://graphviz.org/doc/info/lang.html>`__ of Graphviz: a text describing
     nodes, edges and their attributes, which :program:`dot` lays out and draws.

   Entrypoint
     A named requirements source of a :rst:dir:`dependency-table`: a requirements file or a package as the
     :term:`package index` publishes it, declared in :file:`conf.py`. See :ref:`DIR/DependencyTable`.

   Extension
     A `Sphinx extension <https://www.sphinx-doc.org/en/master/usage/extensions/index.html>`__ is a Python module
     listed in ``extensions`` in :file:`conf.py`, whose ``setup()`` function registers roles, directives, domains or
     event handlers.

   Package Index
     A repository of Python packages answering the `Simple Repository API
     <https://packaging.python.org/en/latest/specifications/simple-repository-api/>`__, e.g. `PyPI
     <https://pypi.org/>`__, which also offers a JSON API with a release's metadata.

   Record
     A Graphviz `record node <https://graphviz.org/doc/info/shapes.html#record>`__, whose label divides the node into
     fields, side by side or one below the other.

   Role
     A `role <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text>`__ is inline markup
     of reStructuredText - ``:name:`text``` - which an extension can add. Sphinx's `list of roles
     <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html>`__ shows the built-in ones.

   Shield
     A small image showing a project's status, e.g. its version or whether its build passes, generated by
     `shields.io <https://shields.io/>`__. Also called a :term:`badge`.

   SPDX License Expression
     An `expression <https://spdx.github.io/spdx-spec/v2.3/SPDX-license-expressions/>`__ of license identifiers from
     the `SPDX License List <https://spdx.org/licenses/>`__, combined with ``AND``, ``OR`` and ``WITH``, e.g.
     ``MIT OR Apache-2.0``.

   Substitution
     A `substitution <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#substitution-references>`__
     is a name in vertical bars - ``|name|`` - replaced by text, an image or, as ``|br|`` here, a role.