Merge branch 'main' into sphinx-autodoc-typehints

docs/reference/changelog.md

@@ -8,6 +8,7 @@ Unreleased changes
 ### Internal
 
 - Improve type annotations and use stricter pyright settings ({gh-pr}`291`)
+- Use `sphinxcontrib.apidoc` to automatically generate API docs from the source code ({gh-pr}`296`)
 
 ---
 

ruff.toml

@@ -26,11 +26,9 @@ ignore = [
     "C408", # Unnecessary `dict` call (rewrite as a literal)
 
     # pydocstyle
-    "D100", # Missing docstring in public module
     "D101", # Missing docstring in public class
     "D102", # Missing docstring in public method
     "D103", # Missing docstring in public function
-    "D104", # Missing docstring in public package
     "D105", # Missing docstring in magic method
     "D107", # Missing docstring in __init__
     "D205", # 1 blank line required between summary line and description
@@ -79,16 +77,21 @@ ignore = [
 
 [lint.per-file-ignores]
 "cicd_utils/*" = [
+    "D100", # Missing docstring in public module
+    "D104", # Missing docstring in public package
     "INP001", # File {x} is part of an implicit namespace package. Add an `__init__.py`
     "T201", # `print` found
 ]
 "docs/conf.py" = [
+    "D100", # Missing docstring in public module
     "ARG001", # Unused function argument
     "INP001", # File {x} is part of an implicit namespace package. Add an `__init__.py`
     "S101",   # Use of assert detected
     "T201",   # `print` found
 ]
 "tests/*" = [
+    "D100", # Missing docstring in public module
+    "D104", # Missing docstring in public package
     "INP001", # File {x} is part of an implicit namespace package. Add an `__init__.py`
     "S101",   # Use of assert detected
     "SLF001", # Private member accessed: `_X`

setup.py

@@ -1,4 +1,6 @@
 #!/usr/bin/env python
+"""setup.py script for ridgeplot."""
+
 from __future__ import annotations
 
 from setuptools import setup

src/ridgeplot/_color/__init__.py

@@ -0,0 +1 @@
+"""Color utilities."""

src/ridgeplot/_color/colorscale.py

@@ -1,3 +1,5 @@
+"""Continuous colorscale utilities."""
+
 from __future__ import annotations
 
 import warnings

src/ridgeplot/_color/css_colors.py

@@ -1,3 +1,5 @@
+"""Mapping of CSS named colors to RGB tuples."""
+
 from __future__ import annotations
 
 from typing_extensions import Literal

src/ridgeplot/_color/interpolation.py

@@ -1,3 +1,5 @@
+"""Color interpolation utilities."""
+
 from __future__ import annotations
 
 from dataclasses import dataclass

src/ridgeplot/_color/utils.py

@@ -1,3 +1,5 @@
+"""Common color utilities."""
+
 from __future__ import annotations
 
 from collections.abc import Collection

src/ridgeplot/_figure_factory.py

@@ -1,3 +1,5 @@
+"""Ridgeline plot figure factory logic."""
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, cast

src/ridgeplot/_hist.py

@@ -1,3 +1,5 @@
+"""Utilities for binning samples into histograms."""
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING

src/ridgeplot/_kde.py

@@ -1,3 +1,5 @@
+"""Kernel density estimation (KDE) utilities."""
+
 from __future__ import annotations
 
 from collections.abc import Callable, Collection

src/ridgeplot/_missing.py

@@ -1,3 +1,5 @@
+"""Missing sentinel class."""
+
 from __future__ import annotations
 
 from enum import Enum

src/ridgeplot/_obj/__init__.py

@@ -0,0 +1 @@
+"""Object-oriented interfaces."""

src/ridgeplot/_obj/traces/__init__.py

@@ -1,3 +1,5 @@
+"""Object-oriented trace interfaces."""
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING

src/ridgeplot/_obj/traces/area.py

@@ -1,3 +1,5 @@
+"""Area trace object."""
+
 from __future__ import annotations
 
 from typing import ClassVar

src/ridgeplot/_obj/traces/bar.py

@@ -1,3 +1,5 @@
+"""Bar trace object."""
+
 from __future__ import annotations
 
 from typing import ClassVar

src/ridgeplot/_obj/traces/base.py

@@ -1,3 +1,5 @@
+"""Base trace object and utilities."""
+
 from __future__ import annotations
 
 from abc import ABC, abstractmethod

src/ridgeplot/_types.py

@@ -1,3 +1,6 @@
+"""Miscellaneous types, type aliases, type guards, and other related utilities
+used throughout the package."""
+
 from __future__ import annotations
 
 from collections.abc import Collection

src/ridgeplot/_utils.py

@@ -1,3 +1,5 @@
+"""Miscellaneous utilities and helper functions."""
+
 from __future__ import annotations
 
 from collections.abc import Collection

src/ridgeplot/datasets/__init__.py

@@ -1,3 +1,5 @@
+"""Loading functions for toy datasets included with the package."""
+
 from __future__ import annotations
 
 import sys