Merge branch 'audreyfeldroy:main' into doc/sphinx

.github/workflows/ci.yml

@@ -10,18 +10,19 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python 3.x
+      - name: Set up Python 3.10
         uses: actions/setup-python@v4
         with:
-          python-version: '3.x'
+          python-version: '3.10'
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install pytest
 
       - name: Test with pytest
-        run: python -m pytest ../../tests/tests.py
+        run: python -m pytest ./tests/tests.py

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# 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-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional 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

README.md

@@ -2,6 +2,8 @@
 
 AI toolkit for professional and amateur historians, and for anyone who wishes to contribute to the recording of history by and for the community.
 
+Join our Discord server: https://discord.gg/TYNuHfEj
+
 ## Project goals and scope
 Some time ago Audrey come in contact with a group of historians working on interviews of survivors of relevant historical events.   
 With the goal of avoiding that this highly valuable first-hand knowledge to be lost down the timeline.  
@@ -52,4 +54,4 @@ or you can use `pip` and run
 python -m venv .venv
 source .venv/bin/activate
 pip install -r requirements.txt
-```
+```