Merge pull request #26 from henrypinkard/main

Potential fix for remote doc build

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).

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'

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