feat: readthedocs initial commit

.readthedocs.yaml

@@ -0,0 +1,17 @@
+# .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 version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+mkdocs:
+  configuration: mkdocs.yml
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: requirements.txt

mkdocs.yml

@@ -0,0 +1,16 @@
+site_name: "JoliGEN"
+theme:
+  name: readthedocs
+  highlightjs: true
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        # See: https://mkdocstrings.github.io/python/usage/
+        python:
+          options:
+            docstring_style: sphinx
+markdown_extensions:
+  - markdown_include.include:
+      base_path: .
+  - admonition

requirements.txt

@@ -20,4 +20,6 @@ onnx
 aim
 git+https://github.com/facebookresearch/segment-anything.git
 piq
-
+jinja2<3.1.0
+markdown-include
+mkdocstrings