Skip to content

Commit 19b94d5

Browse files
committed
Add readthedocs config and conda environment for documentation
1 parent ab3e01b commit 19b94d5

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

.ci_support/environment-docs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
channels:
2+
- conda-forge
3+
dependencies:
4+
- nbsphinx
5+
- sphinx
6+
- myst-parser

.readthedocs.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# .readthedocs.yml
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+
build:
9+
os: "ubuntu-20.04"
10+
tools:
11+
python: "mambaforge-4.10"
12+
13+
# Build documentation in the docs/ directory with Sphinx
14+
sphinx:
15+
configuration: docs/source/conf.py
16+
17+
# Optionally build your docs in additional formats such as PDF and ePub
18+
formats: []
19+
20+
# Install pyiron from conda
21+
conda:
22+
environment: .ci_support/environment-docs.yml
23+
24+
# Optionally set the version of Python and requirements required to build your docs
25+
python:
26+
install:
27+
- method: pip
28+
path: .

0 commit comments

Comments
 (0)