Skip to content

Commit f3a6dd8

Browse files
Create _readthedocs.yml
1 parent b8b6e8c commit f3a6dd8

1 file changed

Lines changed: 73 additions & 0 deletions

File tree

docs/_readthedocs.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# ReadTheDocs configuration for KHA-256
2+
version: 2
3+
4+
build:
5+
os: "ubuntu-22.04"
6+
tools:
7+
python: "3.10"
8+
9+
jobs:
10+
pre_build:
11+
- pip install --upgrade pip setuptools wheel
12+
- pip install -r docs/requirements.txt
13+
14+
sphinx:
15+
configuration: docs/source/conf.py
16+
fail_on_warning: false
17+
18+
python:
19+
install:
20+
- method: pip
21+
path: .
22+
extra_requirements:
23+
- docs
24+
- requirements: docs/requirements.txt
25+
26+
formats:
27+
- pdf
28+
- epub
29+
30+
# Build PDF with custom settings
31+
pdf:
32+
media: "screen" # or 'print'
33+
34+
# Internationalization
35+
language: "en"
36+
37+
# Submodules
38+
submodules:
39+
include:
40+
- all
41+
exclude:
42+
- develop
43+
44+
# Redirects
45+
redirects:
46+
404: /404.html
47+
48+
# Analytics
49+
analytics:
50+
enabled: true
51+
google: null # Add your GA tracking ID if needed
52+
plausible: null
53+
54+
# Notifications
55+
notifications:
56+
email: false
57+
webhook: false
58+
59+
# Search
60+
search:
61+
ranking: {}
62+
ignore: []
63+
64+
# Auto-generated API docs
65+
api_generator:
66+
enabled: true
67+
module: "kha256"
68+
output: "docs/source/api"
69+
70+
# Preview builds for pull requests
71+
preview:
72+
enabled: true
73+
default_branch: "main"

0 commit comments

Comments
 (0)