From 09c689974ff6969cbbafd96a844b2485e88f59bd Mon Sep 17 00:00:00 2001
From: Henry Pinkard <7969470+henrypinkard@users.noreply.github.com>
Date: Mon, 26 Aug 2024 07:31:47 -0400
Subject: [PATCH 1/2] update readme

---
 README.md | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 313e500..de2ca15 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,3 @@
-# Execution engine for microscopy hardware control and data acquisition
-
-## Installation
-
-## Adding device support
-
-
+ExEngine is a pure Python toolkit for building microscopy and laboratory hardware control software. Unlike application-specific software that provide tightly integrated device access, control logic, and user interfaces,ExEngine is a flexible intermediary which enables mixing and matching of components from different frameworks within a single application. This approach allows researchers to build custom software that meets their specific needs, without being limited to vertically integrated software stacks.
 
+For me information, visit the documentation at [https://exengine.readthedocs.io](https://exengine.readthedocs.io).
\ No newline at end of file

From b4ef861e1a22834c7aeb2c8e180ea234413c340a Mon Sep 17 00:00:00 2001
From: Henry Pinkard <7969470+henrypinkard@users.noreply.github.com>
Date: Mon, 26 Aug 2024 07:42:06 -0400
Subject: [PATCH 2/2] potential fix for remote doc build

---
 docs/conf.py     | 6 ++++++
 readthedocs.yaml | 8 ++++++--
 2 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index 254c8c8..0769219 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -6,6 +6,12 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+# Somehow this fixes the docs when built on readthedocs?
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+
 project = 'ExEngine'
 copyright = '2024, Henry Pinkard'
 author = 'Henry Pinkard'
diff --git a/readthedocs.yaml b/readthedocs.yaml
index 5208baf..2224492 100644
--- a/readthedocs.yaml
+++ b/readthedocs.yaml
@@ -12,7 +12,7 @@ build:
   tools:
     python: "3.10"
   jobs:
-    post_checkout:
+    post_checkout: # this deals with git LFS and the figures
       # Download and uncompress the binary
       # https://git-lfs.github.com/
       - wget https://github.com/git-lfs/git-lfs/releases/download/v3.1.4/git-lfs-linux-amd64-v3.1.4.tar.gz
@@ -33,4 +33,8 @@ build:
 # Optionally specify the Python version used by Read the Docs
 python:
   install:
-    - requirements: docs/requirements.txt  
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+    - requirements: docs/requirements.txt
\ No newline at end of file