Merge pull request #10 from unifyai/python_client_docs

added support for docs of the python client
unifyai · Jul 4, 2024 · be0b3b8 · be0b3b8
2 parents b062e0c + ee7d424
commit be0b3b8
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -147,4 +147,8 @@ google-cloud-cli-*.tar.gz
 application_default_credentials.json
 
 # SQL Dump files
-*.dump.sql
+*.dump.sql
+
+# Unify code
+unify
+pyproject.toml
diff --git a/docs/index.rst b/docs/index.rst
@@ -20,6 +20,15 @@
 
 ..  reference/images.rst
 
+.. autosummary::
+  :toctree: docs/unify
+  :template: top_level_toc_recursive.rst
+  :recursive:
+  :hide-table:
+  :caption: Docs
+
+  unify
+
 .. toctree::
   :hidden:
   :maxdepth: 4

diff --git a/docs/partial_conf.py b/docs/partial_conf.py
@@ -15,7 +15,7 @@
 
 
 
-project = "Platform"
+project = "Unify"
 html_title = "Unify Documentation"
 
 # Removing kapa.ai integration

diff --git a/docs/prebuild.sh b/docs/prebuild.sh
@@ -0,0 +1,2 @@
+# this only works if the unify package and the corresponding pyproject.toml file are in the root folder
+pip install $1
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# this only works if the unify package and the corresponding pyproject.toml file are in the root folder
		pip install $1