From 4b84a17970853d358d68e8d7f46f52b3101021fc Mon Sep 17 00:00:00 2001
From: "idan.morad" <idan.morad@rsa.com>
Date: Wed, 7 Feb 2024 14:57:20 +0200
Subject: [PATCH] adding readthe docs yaml

---
 .gitignore        |  1 +
 .readthedocs.yaml | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 36 insertions(+)
 create mode 100644 .readthedocs.yaml

diff --git a/.gitignore b/.gitignore
index da92d06..9615b87 100644
--- a/.gitignore
+++ b/.gitignore
@@ -110,3 +110,4 @@ Temporary Items
 .apdisk
 /tests/result_images/
 /outputdir/
+.pypirc
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..252c68a
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# 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: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# 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
\ No newline at end of file