Skip to content

Restore documentation website build#1435

Merged
bmehta001 merged 2 commits intomicrosoft:mainfrom
bmehta001:bhamehta/fix-docs-website
May 5, 2026
Merged

Restore documentation website build#1435
bmehta001 merged 2 commits intomicrosoft:mainfrom
bmehta001:bhamehta/fix-docs-website

Conversation

@bmehta001
Copy link
Copy Markdown
Contributor

Summary

  • configure ReadTheDocs to use a current Ubuntu/Python build image
  • install Doxygen and Graphviz for the Exhale/Breathe API reference build
  • use the installed Furo theme instead of the missing sphinx_rtd_theme
  • pin Sphinx below 10 because the current Exhale release emits Sphinx 10 compatibility warnings

Validation

  • python -m sphinx -q -b html docs/public docs/public/_build/html with Doxygen on PATH
  • generated docs/public/_build/html/index.html
  • parsed .readthedocs.yaml successfully

ReadTheDocs needs an explicit build image and system packages for the Doxygen-backed Sphinx site. The Sphinx config also referenced a theme that was not installed, so use the existing Furo dependency and pin Sphinx below the next incompatible major version.

Files changed:
- .readthedocs.yaml
- docs/public/conf.py
- docs/public/requirements.txt

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bmehta001 bmehta001 requested a review from a team as a code owner May 3, 2026 06:41
@bmehta001 bmehta001 merged commit 88a8643 into microsoft:main May 5, 2026
27 checks passed
@bmehta001 bmehta001 deleted the bhamehta/fix-docs-website branch May 5, 2026 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants