Skip to content

Commit 482d1b4

Browse files
authored
Merge pull request #2 from netdevops/claude/add-readthedocs-config-xwGqu
Add Read the Docs configuration file for documentation builds
2 parents d519e83 + e4501e2 commit 482d1b4

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

.readthedocs.yaml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
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-22.04
10+
tools:
11+
python: "3.12"
12+
jobs:
13+
post_create_environment:
14+
# Install poetry
15+
- pip install poetry
16+
post_install:
17+
# Install dependencies with poetry
18+
- poetry install --with dev
19+
20+
# Build documentation with MkDocs
21+
mkdocs:
22+
configuration: mkdocs.yml
23+
24+
# Optional but recommended, declare the Python requirements required
25+
# to build your documentation
26+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
27+
python:
28+
install:
29+
- method: pip
30+
path: .

0 commit comments

Comments
 (0)