Skip to content

Commit 4892660

Browse files
authored
Merge pull request #632 from ReproNim/test-rtd-build
Fix readthedocs build
2 parents de82936 + 24a5613 commit 4892660

File tree

2 files changed

+26
-8
lines changed

2 files changed

+26
-8
lines changed

docs/source/glossary.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,14 @@ and API, and provides additional references where to seek more information
3535
cloud instance
3636
A virtual server running on cloud infrastructure (such as AWS EC2) that can be dynamically created, configured, and destroyed. ReproMan uses cloud instances to provide scalable computational resources.
3737

38+
resource
39+
A computational target where ReproMan can execute commands and manage environments. Resources represent different types of compute infrastructure including local machines, virtual machines, cloud instances, and containers.
40+
41+
orchestrator
42+
A component responsible for staging input data and handling results before and after running commands on resources. Examples include plain orchestrators for simple tasks and DataLad-based orchestrators for reproducible workflows.
43+
44+
submitter
45+
A component that handles the actual submission of jobs to execution systems on a resource. Submitters manage different job scheduling systems such as local execution, batch systems (SLURM, PBS), or container orchestration platforms.
46+
3847
.. _Docker: http://docker.io
39-
.. _Singularity: http://singularity.lbl.gov
48+
.. _Singularity: http://singularity.lbl.gov

readthedocs.yml

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
1-
formats:
2-
- epub
3-
- pdf
1+
version: 2
42

5-
requirements_file: requirements.txt
3+
build:
4+
os: ubuntu-22.04
5+
tools:
6+
python: "3.12"
67

7-
python:
8-
version: 2
8+
sphinx:
9+
configuration: docs/source/conf.py
10+
11+
formats:
12+
- pdf
13+
- epub
914

1015
python:
11-
setup_py_install: true
16+
install:
17+
- method: pip
18+
path: .
19+
extra_requirements:
20+
- devel

0 commit comments

Comments
 (0)