Skip to content

Commit 357facf

Browse files
igerberclaude
andcommitted
docs: shorten 3 top-nav labels + bump pydata-sphinx-theme floor
Two independent low-risk nav cleanups: 1. Shorten 3 top-nav labels via toctree entry overrides in docs/index.rst. "Getting Started: Measuring Campaign Impact", "Which Analysis Method Fits Your Problem?", and "Choosing an Estimator" all wrap to 2 lines at 1440x900 desktop, doubling header height from ~64px to 128px (14% of viewport). Use Sphinx's `Label <target>` toctree syntax to render shorter labels in the nav while preserving each page's full H1 title: - Practitioner Guide (was: Getting Started: Measuring Campaign Impact) - Decision Tree (was: Which Analysis Method Fits Your Problem?) - Estimator Guide (was: Choosing an Estimator) Verified locally: header height drops from 128px to 64px; page H1s unchanged; mobile drawer entries 1, 2, 4 reflect the new labels. 2. Bump pydata-sphinx-theme floor >=0.15 -> >=0.16.1 across pyproject.toml, .readthedocs.yaml, and .github/workflows/docs-tests.yml. v0.16+ shipped accessibility improvements. RTD attribution shows 0.17.1 already deployed, but 0.16.1 is the highest floor we can land while keeping Python 3.9 compatibility (0.17.1 requires Python>=3.10, which would conflict with project's requires-python>=3.9). On Python 3.11 (RTD/CI) pip resolves to 0.17.1 as before; on Python 3.9 (local dev) 0.16.1 installs. Verified locally: `make html SPHINXOPTS="-W"` builds clean with pydata-sphinx-theme 0.16.1 installed. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 9ac8f68 commit 357facf

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

.github/workflows/docs-tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ jobs:
9494
# docs/conf.py imports diff_diff via sys.path from checked-out source.
9595
# ipython provides the 'ipython3' Pygments lexer that nbsphinx uses
9696
# for notebook code cells; without it -W fires highlighting_failure.
97-
run: pip install "numpy>=1.20.0" "pandas>=1.3.0" "scipy>=1.7.0" "sphinx>=6.0" "pydata-sphinx-theme>=0.15" "sphinxext-opengraph>=0.9" "sphinx-sitemap>=2.5" "nbsphinx>=0.9" "matplotlib>=3.5" "ipython>=8.0"
97+
run: pip install "numpy>=1.20.0" "pandas>=1.3.0" "scipy>=1.7.0" "sphinx>=6.0" "pydata-sphinx-theme>=0.16.1" "sphinxext-opengraph>=0.9" "sphinx-sitemap>=2.5" "nbsphinx>=0.9" "matplotlib>=3.5" "ipython>=8.0"
9898

9999
- name: Build docs with warnings as errors
100100
# SPHINXOPTS="-W" turns every Sphinx warning into a build failure.

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ build:
1818
#
1919
# Keep in sync with pyproject.toml [project.dependencies]
2020
# and [project.optional-dependencies.docs].
21-
- pip install "numpy>=1.20.0" "pandas>=1.3.0" "scipy>=1.7.0" "sphinx>=6.0" "pydata-sphinx-theme>=0.15" "sphinxext-opengraph>=0.9" "sphinx-sitemap>=2.5" "nbsphinx>=0.9" "matplotlib>=3.5" "ipython>=8.0"
21+
- pip install "numpy>=1.20.0" "pandas>=1.3.0" "scipy>=1.7.0" "sphinx>=6.0" "pydata-sphinx-theme>=0.16.1" "sphinxext-opengraph>=0.9" "sphinx-sitemap>=2.5" "nbsphinx>=0.9" "matplotlib>=3.5" "ipython>=8.0"
2222

2323
# Build documentation in the "docs/" directory with Sphinx
2424
sphinx:

docs/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,16 +59,16 @@ Quick Links
5959
:caption: For Data Scientists
6060
:hidden:
6161

62-
practitioner_getting_started
63-
practitioner_decision_tree
62+
Practitioner Guide <practitioner_getting_started>
63+
Decision Tree <practitioner_decision_tree>
6464

6565
.. toctree::
6666
:maxdepth: 2
6767
:caption: Getting Started
6868
:hidden:
6969

7070
quickstart
71-
choosing_estimator
71+
Estimator Guide <choosing_estimator>
7272
troubleshooting
7373
references
7474

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ plotly = [
6868
]
6969
docs = [
7070
"sphinx>=6.0",
71-
"pydata-sphinx-theme>=0.15",
71+
"pydata-sphinx-theme>=0.16.1",
7272
"sphinxext-opengraph>=0.9",
7373
"sphinx-sitemap>=2.5",
7474
"nbsphinx>=0.9",

0 commit comments

Comments
 (0)