From 6631236e87c9c12468f2d5ae928b34706923653c Mon Sep 17 00:00:00 2001 From: "claude[bot]" <41898282+claude[bot]@users.noreply.github.com> Date: Mon, 13 Apr 2026 04:04:14 +0000 Subject: [PATCH] Fix ReadTheDocs configuration to restore docs updates - Add .readthedocs.yaml (required by ReadTheDocs for all builds) - Fix docs/index.rst to include source/modules in toctree - Add docs/requirements.txt with Sphinx dependencies Fixes #324 Co-authored-by: Anand Sanmukhani <4n4nd@users.noreply.github.com> --- .readthedocs.yaml | 20 ++++++++++++++++++++ docs/index.rst | 2 ++ docs/requirements.txt | 2 ++ 3 files changed, 24 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..e14909b --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,20 @@ +# ReadTheDocs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +sphinx: + configuration: docs/conf.py + +python: + install: + - requirements: docs/requirements.txt + - method: pip + path: . + extra_requirements: + - all diff --git a/docs/index.rst b/docs/index.rst index d999f04..822d253 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,8 @@ Welcome to Prometheus Client API Python's documentation! :maxdepth: 2 :caption: Contents: + source/modules + Indices and tables diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..cbf1e36 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx +sphinx-rtd-theme