temp commit to add readthedocs file

Author: jeremymanning

README.md

@@ -1,6 +1,7 @@
 # Clustrix
 
 [![Tests](https://github.com/ContextLab/clustrix/actions/workflows/tests.yml/badge.svg)](https://github.com/ContextLab/clustrix/actions/workflows/tests.yml)
+[![Coverage](https://raw.githubusercontent.com/ContextLab/clustrix/master/coverage.svg)](https://github.com/ContextLab/clustrix/actions/workflows/coverage-badge.yml)
 [![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 

clustrix.egg-info/PKG-INFO

@@ -34,6 +34,12 @@ Requires-Dist: pytest-cov>=2.0; extra == "dev"
 Requires-Dist: black>=21.0; extra == "dev"
 Requires-Dist: flake8>=3.8; extra == "dev"
 Requires-Dist: mypy>=0.812; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest>=6.0; extra == "test"
+Requires-Dist: pytest-cov>=2.0; extra == "test"
+Requires-Dist: coverage>=6.0; extra == "test"
+Requires-Dist: pytest-xdist>=2.0; extra == "test"
+Requires-Dist: pytest-mock>=3.0; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx>=4.0; extra == "docs"
 Requires-Dist: groundwork-sphinx-theme>=1.1.1; extra == "docs"
@@ -57,6 +63,11 @@ Requires-Dist: ipython>=7.0; extra == "all"
 
 # Clustrix
 
+[![Tests](https://github.com/ContextLab/clustrix/actions/workflows/tests.yml/badge.svg)](https://github.com/ContextLab/clustrix/actions/workflows/tests.yml)
+[![Coverage](https://raw.githubusercontent.com/ContextLab/clustrix/master/coverage.svg)](https://github.com/ContextLab/clustrix/actions/workflows/coverage-badge.yml)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 Clustrix is a Python package that enables seamless distributed computing on clusters. With a simple decorator, you can execute any Python function remotely on cluster resources while automatically handling dependency management, environment setup, and result collection.
 
 ## Features

clustrix.egg-info/SOURCES.txt

@@ -23,4 +23,5 @@ tests/test_config.py
 tests/test_decorator.py
 tests/test_executor.py
 tests/test_integration.py
+tests/test_local_executor.py
 tests/test_utils.py

clustrix.egg-info/requires.txt

@@ -35,3 +35,10 @@ ipython>=7.0
 
 [kubernetes]
 kubernetes>=20.13.0
+
+[test]
+pytest>=6.0
+pytest-cov>=2.0
+coverage>=6.0
+pytest-xdist>=2.0
+pytest-mock>=3.0

docs/.readthedocs.yaml

@@ -0,0 +1,24 @@
+
+
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

docs/source/index.rst

@@ -84,6 +84,9 @@ Table of Contents
    :maxdepth: 2
    :caption: Tutorials
 
+   tutorials/slurm_tutorial
+   tutorials/pbs_tutorial
+   tutorials/kubernetes_tutorial
    tutorials/basic_usage
    tutorials/machine_learning
    tutorials/scientific_computing