Skip to content

Commit 82ab70a

Browse files
jeremymanningclaude
andcommitted
Add Read the Docs configuration
- Add .readthedocs.yaml configuration file for RTD builds - Update docs/doc_requirements.txt with comprehensive dependencies - Include all necessary packages for documentation build - Configure Python 3.9 and Ubuntu 22.04 for RTD environment 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 493bd08 commit 82ab70a

2 files changed

Lines changed: 46 additions & 6 deletions

File tree

.readthedocs.yaml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.9"
13+
# You can also specify other tools here or in a separate tools block
14+
15+
# Build documentation in the docs/ directory with Sphinx
16+
sphinx:
17+
configuration: docs/conf.py
18+
19+
# If using Sphinx, optionally build your docs in additional formats such as PDF
20+
# formats:
21+
# - pdf
22+
23+
# Optionally declare the Python requirements required to build your docs
24+
python:
25+
install:
26+
- method: pip
27+
path: .
28+
- requirements: docs/doc_requirements.txt

docs/doc_requirements.txt

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
1-
sphinx==2.3.0
2-
sphinx_bootstrap_theme==0.6.4
3-
sphinx-gallery
4-
numpydoc
1+
sphinx>=4.0.0
2+
sphinx_bootstrap_theme>=0.7.0
3+
sphinx-gallery>=0.10.0
4+
numpydoc>=1.1.0
55
deepdish
6-
nbsphinx
7-
jupyter_client
6+
nbsphinx>=0.8.0
7+
jupyter_client>=6.0.0
88
wikipedia
9+
ipython
10+
# Main package dependencies
11+
PPCA>=0.0.2
12+
scikit-learn>=1.4.0
13+
pandas>=2.2.0
14+
seaborn>=0.13.0
15+
matplotlib>=3.8.0
16+
scipy>=1.13.0
17+
numpy>=2.0.0
18+
umap-learn>=0.5.5
19+
requests>=2.31.0
20+
ipympl>=0.9.3

0 commit comments

Comments
 (0)