Skip to content

Commit 75e2421

Browse files
authored
Add Read the Docs configuration (#1061)
1 parent a09fc4c commit 75e2421

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

.github/workflows/rtd-preview.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Read the Docs PR preview
2+
on:
3+
pull_request_target:
4+
types:
5+
- opened
6+
7+
permissions:
8+
pull-requests: write
9+
10+
jobs:
11+
documentation-links:
12+
runs-on: ubuntu-latest
13+
timeout-minutes: 10
14+
steps:
15+
- uses: readthedocs/actions/preview@v1
16+
with:
17+
project-slug: "ep-website-demo"
18+
single-version: "true"
19+
message-template: "🖼️ Preview available 🖼️ : {docs-pr-index-url}"

.readthedocs.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version, and other tools you might need
8+
build:
9+
os: ubuntu-24.04
10+
tools:
11+
# Specify the language and version your project requires,
12+
# by uncommenting one of the following tools.
13+
#
14+
# python: "3.13"
15+
# ruby: "3.3"
16+
nodejs: "22"
17+
# rust: "1.82"
18+
# golang: "1.23"
19+
20+
commands:
21+
- npm install -g pnpm@latest-10
22+
- make install
23+
- make build PREVIEW=true
24+
- mkdir -p $READTHEDOCS_OUTPUT/html
25+
- cd dist && cp -r * $READTHEDOCS_OUTPUT/html

0 commit comments

Comments
 (0)