Glossary

This document lists terms that are used in ESP-Docs documentation. Each term is followed by its definition and some have notes.

add-ons

Definition: Add-ons are small programs that expand or extend the features of a browser.

blockdiag

Definition: blockdiag is an application that generates raster images from plaintext .diag source files.

Note: Do not capitalize the first letter b when using this term.

dependency

Definition: When a project consumes executable code generated by another project, the project that generates the code is referred to as a project dependency of the project that consumes the code.

Docutils

Definition: Docutils is an open-source text processing system for processing plaintext documentation into useful formats, such as HTML, LaTeX, man-pages, OpenDocument, or XML.

Doxygen

Definition: Doxygen is a documentation generator and static analysis tool for software source trees.

ESP-Docs

Definition: ESP-Docs is a documentation-building system developed by Espressif based on Sphinx and Read the Docs. It expands Sphinx functionality and extensions with the features needed for Espressif’s documentation and bundles this into a single package. See What Is ESP-Docs? for more information.

Note: ESP-Docs is used as a proper noun just like other documentation generators including Sphinx, or software products like ESP-IDF and ESP-IoT Solution. Use esp-docs only in the repo name, code, command line, folder/file name, etc.

Graphviz

Definition: Graphviz is a package of open-source tools for drawing graphs specified in DOT language scripts having the file name extension “gv”.

interactive shell

An interactive shell is defined as the shell that simply takes commands as input on tty from the user and acknowledges the output to the user.

LaTeX

Definition: LaTeX is a software system for document preparation. When writing, the writer uses plain text as opposed to the formatted text found in WYSIWYG word processors like Microsoft Word, LibreOffice Writer and Apple Pages.

Note: T and X should be capitalized.

Markdown

Definition: Markdown is a lightweight markup language for creating formatted text using a plaintext editor.

Note: When placed in documentation, the first letter should be capitalized.

Read the Docs

Definition: Read the Docs is an open-sourced free software documentation hosting platform. It generates documentation written with the Sphinx documentation generator.

Note: Spaces should be added around the, and D should be capitalized.

reStructuredText

Definition: reStructuredText is a file format for textual data used primarily in the Python programming language community for technical documentation.

Note: Abbreviations of this term include reST, or rst. When using its full name, S and T should be capitalized, while r remains lowercase.

slug

Definition: A unique identifier for a project, version, or target. This value comes from the project, version name, or target name, such as esp-idf, release-v5.0, or esp32 in https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32/index.html.

Sphinx

Definition: Sphinx is a powerful documentation generator that has many great features for writing technical documentation.

Note: When placed in documentation, S should be capitalized.

target

Definition: Represents a series of Espressif products for which you build documentation, e.g., ESP32, ESP32-S2, ESP32-C3.

WaveDrom

Definition: WaveDrom draws your Timing Diagram or Waveform from a simple textual description.

Provide feedback about this document