Skip to content

Commit 14dd264

Browse files
authored
Merge pull request #3 from rit-coms/dev/read-the-docs
Read the Docs
2 parents dec6a78 + 86c08e8 commit 14dd264

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

.readthedocs.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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+
python: 3.12
12+
13+
# Build documentation in the "docs/" directory with Sphinx
14+
sphinx:
15+
configuration: docs/source/conf.py
16+
17+
# Optionally, but recommended,
18+
# declare the Python requirements required to build your documentation
19+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
20+
python:
21+
install:
22+
- requirements: docs/requirements.txt
23+
24+

docs/requirements.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Sphinx==8.2.3
2+
sphinxcontrib-applehelp==2.0.0
3+
sphinxcontrib-devhelp==2.0.0
4+
sphinxcontrib-htmlhelp==2.1.0
5+
sphinxcontrib-jsmath==1.0.1
6+
sphinxcontrib-qthelp==2.0.0
7+
sphinxcontrib-serializinghtml==2.0.0

0 commit comments

Comments
 (0)