Skip to content

Commit e6c90e5

Browse files
committed
read the docs config + docs pip requirements
1 parent a538220 commit e6c90e5

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

.readthedocs.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version and other tools you might need
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.12"
12+
13+
# Build documentation in the "docs/" directory with Sphinx
14+
sphinx:
15+
configuration: docs/conf.py
16+
# # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
17+
builder: html
18+
# Fail on all warnings to avoid broken references
19+
# fail_on_warning: true
20+
21+
# Optionally build your docs in additional formats such as PDF and ePub
22+
formats:
23+
- pdf
24+
25+
# Optional but recommended, declare the Python requirements required
26+
# to build your documentation
27+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
28+
python:
29+
install:
30+
- method: pip
31+
path: .
32+
extra_requirements:
33+
- docs

pyproject.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@ test = [
3737
"miniopy-async==1.21.1"
3838
]
3939

40+
docs = [
41+
"sphinx>=5.0",
42+
"sphinx-copybutton",
43+
"myst-parser",
44+
"furo",
45+
]
46+
4047
[project.scripts]
4148
servicex-get-structure = "servicex_analysis_utils.cli:app"
4249

0 commit comments

Comments
 (0)