Skip to content

Commit 155dedf

Browse files
committed
Add readthedocsc config
1 parent 5193af2 commit 155dedf

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

.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 for MkDocs 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 version of Python and other tools you might need
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.11"
12+
13+
mkdocs:
14+
configuration: mkdocs.yml
15+
16+
python:
17+
install:
18+
- method: pip
19+
path: .
20+
extra_requirements:
21+
- docs
22+
23+
submodules:
24+
include: all
25+
recursive: true

pyproject.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,8 @@ requires = [
4242
"ninja",
4343
]
4444
build-backend = "setuptools.build_meta"
45+
46+
[project.optional-dependencies]
47+
server = ["uvicorn", "fastapi", "sse-starlette"]
48+
test = ["pytest"]
49+
docs = ["mkdocs", "mkdocstrings[python]", "mkdocs-material"]

0 commit comments

Comments
 (0)