Skip to content

Commit 2943116

Browse files
authored
Fix ReadTheDocs by adding configuration file (#693)
The documentation is failing to upload to ReadTheDocs [because it doesn't build](https://app.readthedocs.org/projects/hazelcast/builds/25183105/): > Config file not found at default path The required .readthedocs.yaml configuration file was not found at repository's root. This means that the [latest available version](https://hazelcast.readthedocs.io/en/latest/) listed is `v5.3.0`, `v5.4.0` is missing: ![image](https://github.com/user-attachments/assets/dfc91853-8988-43d4-a429-03f401147edb) I've created a simple configuration [based on their documentation](https://docs.readthedocs.io/en/stable/config-file/index.html) to address this. I've [built this on ReadTheDocs](https://app.readthedocs.org/projects/hazelcast/builds/25186169/) to create a public-but-unlisted site [here](https://hazelcast.readthedocs.io/en/fix-readthedocs-3/). Discovered by [PR feedback](hazelcast/rel-scripts#22 (comment)).
1 parent 5a3556a commit 2943116

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

.readthedocs.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Read the Docs configuration file for Sphinx projects
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: latest
10+
11+
sphinx:
12+
configuration: docs/conf.py
13+
14+
python:
15+
install:
16+
- requirements: requirements-dev.txt

0 commit comments

Comments
 (0)