Repository navigation
docs: pydata-sphinx-theme instead of the ESP-IDF theme; API reference page (docs rework, stage 1) - #891
Merged
Conversation
… page First stage of the docs rework. esp-docs still runs Doxygen and provides the API directives; the look and the navigation change. - No chip selector and no ESP-IDF version list (both were the old theme's, the latter fed by Espressif's version file), espp's logo and favicon (the organisation image with its background lifted; esp-docs forces the Espressif logo at extension load, a config-inited hook behind its own replaces it). A top bar, the section navigation on the left as a panel of its own, the page outline and an edit button on the right, breadcrumbs, previous / next, light and dark modes, search, GitHub and Discord links. - The index had thirteen captioned toctrees, which this theme turns into a navbar that overflows into "More". A new api_reference page holds the capability groups (the captions become sidebar headings); the index keeps a short top-level toctree and a list of the groups. - The theme's version switcher is wired in the next stage (versioned publishing: latest plus one entry per release/v* branch); the option sits in conf_common.py, commented. - docutils<0.21 pinned: esp-docs' target-substitution extension imports a module docutils 0.21 removed, and the theme would otherwise pull a newer docutils. The old theme's config values that esp-docs' LaTeX and html-zip extensions still read are registered by our setup(). doc/README gains the recipe for building locally without Docker. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DFjjnq3XCTRAXENSxsCxJU
|
✅Static analysis result - no issues found! ✅ |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain for the documentation theme and navigation changes.
No open issues 🎉
What changed in this PR
This PR starts the documentation redesign by replacing the ESP-IDF theme with pydata-sphinx-theme, while retaining esp-docs for Doxygen and API integration. Publishing remains unchanged.
Changes:
- Configure espp branding, navigation, sidebars, and light/dark theme support.
- Move capability groups into a dedicated API Reference page and simplify top-level navigation.
- Add theme dependencies, compatibility configuration, and native build instructions.
| File | Description |
|---|---|
doc/requirements.txt |
Add the new theme and pin docutils for esp-docs compatibility. |
doc/README.md |
Document local builds without Docker. |
doc/en/index.rst |
Simplify navigation and link to API capability groups. |
doc/en/api_reference.rst |
Collect component groups into a dedicated API landing page. |
doc/en/_static/espp.css |
Add horizontal overflow handling for signatures and diagrams. |
doc/conf_common.py |
Configure the theme, branding, navigation, and esp-docs compatibility hooks. |
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
First stage of the docs rework: the site moves from esp-docs'
sphinx_idf_themeto pydata-sphinx-theme (the NumPy / pandas / Jupyter docs theme). esp-docs still runs Doxygen and provides the API directives; only the look and the navigation change.config-initedhook behind esp-docs' own replaces it. The logo is the esp-cpp organisation image with its background lifted; a proper SVG can drop in later.api_referencepage holds the capability groups (the captions become sidebar headings), and the index keeps a short top-level toctree plus a list of the groups.latestplus one entry perrelease/v*branch) will generate. The option is inconf_common.py, commented, ready for it.docutils<0.21pinned indoc/requirements.txt(esp-docs' target-substitution extension imports a module docutils 0.21 removed; the theme would otherwise pull a newer docutils); the old theme's config values that esp-docs' LaTeX and html-zip extensions still read are registered by oursetup().doc/README.mdgains the recipe for building locally without Docker.Nothing about the published layout changes in this PR (still the site root); the workflow is untouched.
Test plan
🤖 Generated with Claude Code
https://claude.ai/code/session_01DFjjnq3XCTRAXENSxsCxJU