Glossary

Badge

See Shield.

Directive

A directive is an explicit markup block of reStructuredText - .. name:: arguments with options and content - which an extension can add. Sphinx’s list of directives shows the built-in ones.

DOT

The graph description language of Graphviz: a text describing nodes, edges and their attributes, which dot lays out and draws.

Entrypoint

A named requirements source of a dependency-table: a requirements file or a package as the package index publishes it, declared in conf.py. See dependency-table.

Extension

A Sphinx extension is a Python module listed in extensions in conf.py, whose setup() function registers roles, directives, domains or event handlers.

Package Index

A repository of Python packages answering the Simple Repository API, e.g. PyPI, which also offers a JSON API with a release’s metadata.

Record

A Graphviz record node, whose label divides the node into fields, side by side or one below the other.

Role

A role is inline markup of reStructuredText - :name:`text` - which an extension can add. Sphinx’s list of roles 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. Also called a badge.

SPDX License Expression

An expression of license identifiers from the SPDX License List, combined with AND, OR and WITH, e.g. MIT OR Apache-2.0.

Substitution

A substitution is a name in vertical bars - |name| - replaced by text, an image or, as |br| here, a role.