#8 docs setup global documentation (#12)

* reformating docs + README * overview + setting up doc parts * handling emojis * handling emojis * about page * setting WIP * build files before PR * setting WIP * build files before PR * removing build files
easy-model-fusion · Mar 20, 2024 · b6f971f · b6f971f
1 parent ba501ba
commit b6f971f
Show file tree

Hide file tree

Showing 64 changed files with 74 additions and 18,663 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+build/
+.idea/
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# Setup
+
+Installing sphinx
+```shell
+apt-get install python3-sphinx
+```
+
+Installing the theme
+```shell
+pip install --upgrade sphinx_rtd_theme
+```
+
+Installing emojis :
+https://sphinxemojicodes.readthedocs.io/en/stable/
+
+# Build
+
+Building for HTML
+```shell
+make html
+```
+
diff --git a/build/doctrees/client.doctree b/build/doctrees/client.doctree
diff --git a/build/doctrees/environment.pickle b/build/doctrees/environment.pickle
diff --git a/build/doctrees/index.doctree b/build/doctrees/index.doctree
diff --git a/build/doctrees/sdk.doctree b/build/doctrees/sdk.doctree
diff --git a/build/html/.buildinfo b/build/html/.buildinfo
diff --git a/build/html/_sources/client.rst.txt b/build/html/_sources/client.rst.txt
diff --git a/build/html/_sources/index.rst.txt b/build/html/_sources/index.rst.txt
diff --git a/build/html/_sources/sdk.rst.txt b/build/html/_sources/sdk.rst.txt
diff --git a/build/html/_static/_sphinx_javascript_frameworks_compat.js b/build/html/_static/_sphinx_javascript_frameworks_compat.js