Principle:DistrictDataLabs Yellowbrick Documentation Build
| Knowledge Sources | |
|---|---|
| Domains | Documentation, Build_System |
| Last Updated | 2026-02-08 05:00 GMT |
Overview
Principle of using Sphinx with domain-specific extensions (numpydoc, plot_directive) to generate comprehensive API documentation from source code docstrings and inline examples.
Description
Sphinx-based documentation builds extract docstrings from Python source code, render inline plot examples, cross-reference external projects via intersphinx, and produce both HTML and LaTeX/PDF output. Gallery image generators create standardized thumbnails for the documentation website.
Usage
Use this principle when contributing to Yellowbrick documentation or understanding the documentation build system.
Theoretical Basis
Literate Documentation: Source code and documentation coexist, with docstrings serving as the single source of truth for API documentation.
Related Pages
Page Connections
Double-click a node to navigate. Hold to expand connections.
Principle
Implementation
Heuristic
Environment