Skip to content

Commit 4d234be

Browse files
fix: repair ReadTheDocs build configuration
1 parent 5f509de commit 4d234be

1 file changed

Lines changed: 19 additions & 29 deletions

File tree

.readthedocs.yaml

Lines changed: 19 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,35 @@
11
# .readthedocs.yaml
2-
# Read the Docs configuration file optimized for thorough code extraction
2+
# Read the Docs configuration file
33
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
44

55
version: 2
66

7-
# Set the OS and Python version
87
build:
98
os: ubuntu-22.04
109
tools:
11-
python: "3.14" # Using a stable Python version supported by ReadTheDocs
12-
jobs:
13-
post_create_environment:
14-
# Install poetry and configure it
15-
- pip install poetry
16-
- poetry config virtualenvs.create false
17-
post_install:
18-
- poetry install --with docs
19-
20-
# Use the latest version of build system
21-
python:
22-
install:
23-
- method: pip
24-
path: .
25-
extra_requirements:
26-
- docs
27-
- requirements: docs/source/requirements.txt
28-
29-
# Build documentation with maximum extraction settings
30-
#sphinx:
31-
# configuration: docs/source/conf.py
32-
# fail_on_warning: false # Set to true once your docs are stable
33-
# builder: html
10+
python: "3.13"
11+
commands:
12+
- pip install uv
13+
- uv sync --group docs
14+
- uv run mkdocs build -f docs/mkdocs.yml --site-dir $READTHEDOCS_OUTPUT/html
3415

3516
mkdocs:
3617
configuration: docs/mkdocs.yml
3718
fail_on_warning: false
3819

39-
# Search settings
4020
search:
4121
ranking:
42-
# These paths will be ranked higher in search results
43-
api_reference/*: 2
44-
installation.md: 3
22+
index.md: 5
23+
installation.md: 5
24+
usage.md: 4
25+
features.md: 3
26+
api_reference/index.md: 4
27+
api_reference/**/*: 3
28+
examples/index.md: 4
29+
examples/**/*: 3
4530
architecture.md: 2
31+
changelog.md: 2
32+
development.md: 2
33+
contributing.md: 1
34+
contributing-docs.md: 1
35+
license.md: -3

0 commit comments

Comments
 (0)