Skip to content

Commit bbf6576

Browse files
committed
docs: Add readthedocs configuration file, update dependencies
See: https://docs.readthedocs.com/platform/stable/config-file/index.html Bug: https://phabricator.wikimedia.org/T407180
1 parent c26bfb7 commit bbf6576

File tree

3 files changed

+30
-4
lines changed

3 files changed

+30
-4
lines changed

.readthedocs.yaml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
# Required
4+
version: 2
5+
6+
# Set the OS, Python version and other tools you might need
7+
build:
8+
os: ubuntu-24.04
9+
tools:
10+
python: "3.12"
11+
12+
# Build documentation in the "docs/" directory with Sphinx
13+
sphinx:
14+
configuration: docs/conf.py
15+
16+
# Optionally build your docs in additional formats such as PDF and ePub
17+
# formats:
18+
# - pdf
19+
# - epub
20+
21+
# Optional but recommended, declare the Python requirements required
22+
# to build your documentation
23+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
24+
python:
25+
install:
26+
- requirements: docs/requirements.txt

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
# -- Project information -----------------------------------------------------
2121

2222
project = u'LanguageData'
23-
copyright = u'2020, Wikimedia Foundation'
23+
copyright = u'2025, Wikimedia Foundation'
2424
author = u'Wikimedia Foundation'
2525

2626
# The short X.Y version

docs/requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Sphinx==1.8.4
2-
sphinx-rtd-theme==0.4.2
3-
sphinxcontrib-phpdomain==0.6.3
1+
Sphinx>=7.0
2+
sphinx-rtd-theme>=1.2
3+
sphinxcontrib-phpdomain>=0.8.0
44
doxyphp2sphinx>=1.0.1

0 commit comments

Comments
 (0)