Terminology

Common Terms and Definitions

API Application Programming Interface - A set of rules and protocols for building software applications.

Sphinx Documentation generator tool that reads reStructuredText or Markdown and produces HTML, PDF, and other formats.

toctree Table of Contents Tree - A Sphinx directive that defines the document structure and navigation.

Markdown A lightweight markup language used for writing documentation.

reStructuredText (RST) A plaintext markup syntax used by Sphinx for documentation.

MyST Parser A parser that enables Sphinx to use Markdown instead of just reStructuredText.

Read the Docs Theme A professional, responsive Sphinx theme commonly used for documentation projects.

Build Language The language version being built (English, Chinese, or Japanese).

Localization The process of adapting documentation for different languages and regions.