Skip to content

Commit 6631236

Browse files
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>
1 parent e17eae4 commit 6631236

3 files changed

Lines changed: 24 additions & 0 deletions

File tree

.readthedocs.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# ReadTheDocs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
version: 2
5+
6+
build:
7+
os: ubuntu-22.04
8+
tools:
9+
python: "3.11"
10+
11+
sphinx:
12+
configuration: docs/conf.py
13+
14+
python:
15+
install:
16+
- requirements: docs/requirements.txt
17+
- method: pip
18+
path: .
19+
extra_requirements:
20+
- all

docs/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Welcome to Prometheus Client API Python's documentation!
1010
:maxdepth: 2
1111
:caption: Contents:
1212

13+
source/modules
14+
1315

1416

1517
Indices and tables

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
sphinx
2+
sphinx-rtd-theme

0 commit comments

Comments
 (0)