Skip to content

Commit bfcc4f1

Browse files
docs: Add Read the Docs configuration file and docs requirements
Made-with: Cursor
1 parent 01a3f9b commit bfcc4f1

2 files changed

Lines changed: 35 additions & 0 deletions

File tree

.readthedocs.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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.13"
12+
13+
# Build documentation in the "meridianalgo/docs/source/" directory with Sphinx
14+
sphinx:
15+
configuration: meridianalgo/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

docs/requirements.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Documentation build requirements for Read the Docs
2+
# These are the dependencies needed to build the Sphinx documentation
3+
4+
# Sphinx and theme
5+
sphinx>=7.0.0
6+
sphinx-rtd-theme>=1.3.0
7+
nbsphinx>=0.8.0
8+
sphinx-copybutton>=0.4.0
9+
10+
# Core package dependencies (for autodoc)
11+
numpy>=1.24.0
12+
pandas>=2.0.0
13+
scipy>=1.10.0

0 commit comments

Comments
 (0)