Implementation:DistrictDataLabs Yellowbrick Sphinx Documentation Config
| Knowledge Sources | |
|---|---|
| Domains | Documentation, Build_System |
| Last Updated | 2026-02-08 05:00 GMT |
Overview
Sphinx documentation build configuration defining extensions, themes, and output settings for the Yellowbrick project documentation.
Description
The docs/conf.py file configures Sphinx for building Yellowbrick's documentation. It registers extensions including numpydoc for NumPy-style docstrings, matplotlib's plot_directive for rendering inline plots, intersphinx for cross-referencing external projects, and the todo extension. It sets the Alabaster HTML theme with custom sidebar and navigation options, and configures LaTeX output for PDF generation.
Usage
This configuration is invoked automatically when building documentation via `make html` or `sphinx-build` in the `docs/` directory. Contributors modifying documentation should be aware of the registered extensions and template paths.
Code Reference
Source Location
- Repository: DistrictDataLabs_Yellowbrick
- File: docs/conf.py
- Lines: 1-418
Signature
# Key configuration variables
project = "Yellowbrick"
copyright = "2016-2019, The scikit-yb developers."
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
"sphinx.ext.todo",
"numpydoc",
"matplotlib.sphinxext.plot_directive",
]
html_theme = "alabaster"
Import
# Not imported by user code; used by sphinx-build
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| (Sphinx build system) | — | — | Invoked by sphinx-build |
Outputs
| Name | Type | Description |
|---|---|---|
| HTML docs | HTML files | Built documentation in docs/_build/html |
| LaTeX docs | LaTeX files | Built documentation for PDF |
Usage Examples
# Build documentation from the docs/ directory
cd docs && make html