From 341ed3f274232a0b2748a87144d0ab9e16eef08d Mon Sep 17 00:00:00 2001 From: vedpatwardhan Date: Thu, 4 Jul 2024 21:24:09 +0530 Subject: [PATCH 1/3] added support for docs of the python client --- .gitignore | 6 +++++- docs/index.rst | 9 +++++++++ docs/partial_conf.py | 2 +- docs/prebuild.sh | 1 + 4 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 docs/prebuild.sh diff --git a/.gitignore b/.gitignore index b8cbee1..c6f166c 100644 --- a/.gitignore +++ b/.gitignore @@ -147,4 +147,8 @@ google-cloud-cli-*.tar.gz application_default_credentials.json # SQL Dump files -*.dump.sql \ No newline at end of file +*.dump.sql + +# Unify code +unify +pyproject.toml diff --git a/docs/index.rst b/docs/index.rst index cc540fd..6474101 100644 --- 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 index 7497b09..b5f7364 100644 --- 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 new file mode 100644 index 0000000..b55bec9 --- /dev/null +++ b/docs/prebuild.sh @@ -0,0 +1 @@ +pip install $1 \ No newline at end of file From 8f527222a05b127c11d40de37ed4df0a20a6e78f Mon Sep 17 00:00:00 2001 From: vedpatwardhan Date: Thu, 4 Jul 2024 21:25:14 +0530 Subject: [PATCH 2/3] minor change --- docs/prebuild.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/prebuild.sh b/docs/prebuild.sh index b55bec9..02b0824 100644 --- a/docs/prebuild.sh +++ b/docs/prebuild.sh @@ -1 +1 @@ -pip install $1 \ No newline at end of file +pip install $1 From ee7d42444baf54e831893a3b613b9526fa306b92 Mon Sep 17 00:00:00 2001 From: vedpatwardhan Date: Thu, 4 Jul 2024 21:34:19 +0530 Subject: [PATCH 3/3] added comment --- docs/prebuild.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/prebuild.sh b/docs/prebuild.sh index 02b0824..4c6df4b 100644 --- a/docs/prebuild.sh +++ b/docs/prebuild.sh @@ -1 +1,2 @@ +# this only works if the unify package and the corresponding pyproject.toml file are in the root folder pip install $1