From 15aca9d84aec3810313e2d8b71065f940b4a6e08 Mon Sep 17 00:00:00 2001 From: Bhagirath Mehta Date: Sun, 3 May 2026 01:40:35 -0500 Subject: [PATCH] Restore documentation website build 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> --- .readthedocs.yaml | 14 +++++++++++--- docs/public/conf.py | 11 ++++------- docs/public/requirements.txt | 3 ++- 3 files changed, 17 insertions(+), 11 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 281bf4b1f..dec4558cd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,11 +1,19 @@ version: 2 +build: + os: ubuntu-24.04 + tools: + python: "3.12" + apt_packages: + - doxygen + - graphviz + submodules: exclude: all python: - install: - - requirements: docs/public/requirements.txt + install: + - requirements: docs/public/requirements.txt sphinx: - configuration: docs/public/conf.py + configuration: docs/public/conf.py diff --git a/docs/public/conf.py b/docs/public/conf.py index d38fa3f7b..1d29ebe99 100644 --- a/docs/public/conf.py +++ b/docs/public/conf.py @@ -16,7 +16,7 @@ # -- Project information ----------------------------------------------------- -project = 'Microsoft C++ Client Telemetry SDK"' +project = 'Microsoft C++ Client Telemetry SDK' copyright = 'Microsoft Corporation' author = 'Microsoft Corporation' @@ -28,8 +28,6 @@ # This is necessary so the readthedocs build works. It doesn't invoke the # Makefile, but just runs sphinx on this conf.py. import os -import shutil -import subprocess if not os.path.exists('doxyoutput'): os.makedirs('doxyoutput') @@ -61,7 +59,7 @@ primary_domain = "cpp" -higlight_language = "cpp" +highlight_language = "cpp" # Add any paths that contain templates here, relative to this directory. @@ -78,10 +76,9 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -#html_theme = "furo" -html_theme = "sphinx_rtd_theme" +html_theme = "furo" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file +html_static_path = [] diff --git a/docs/public/requirements.txt b/docs/public/requirements.txt index 7419647ac..92d9b3915 100644 --- a/docs/public/requirements.txt +++ b/docs/public/requirements.txt @@ -1,3 +1,4 @@ +sphinx<10 breathe exhale -furo \ No newline at end of file +furo