From e4367e679b0dc6caa75d0d7cb0120998e603be0b Mon Sep 17 00:00:00 2001 From: Robin de Rooij Date: Tue, 23 Aug 2022 15:45:06 +0200 Subject: [PATCH 1/5] Just only run the docs PR --- .github/workflows/docs.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 147f1772..84f8f4d5 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -5,8 +5,6 @@ name: Generate docs and Create PR on docs repo on: push: - tags: - - v* jobs: make_docs: From 252fbfe4e484172d8856239648621e2e0edb6d62 Mon Sep 17 00:00:00 2001 From: Robin de Rooij Date: Tue, 23 Aug 2022 16:16:23 +0200 Subject: [PATCH 2/5] fix generateGitBookMD.py --- docs/generateGitbookMD.py | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/docs/generateGitbookMD.py b/docs/generateGitbookMD.py index da251632..cfa7f5fc 100644 --- a/docs/generateGitbookMD.py +++ b/docs/generateGitbookMD.py @@ -20,15 +20,6 @@ f_dir = "./build/markdown/" -f_input = ['Errors_and_Exceptions', - 'modules', - 'Scaffolding_CLI_Tool', - 'woqlClient', - 'woqlDataframe', - 'woqlQuery', - 'woqlSchema', -] - aPyFile = [] f_md = None @@ -148,12 +139,13 @@ def _md(line, nL = 0): print(error) # Loop through each file for conversion -for f in glob.glob('./build/markdown/*.md'): - print(f) - file = open(f, "r") +for f in glob.glob(f"{f_dir}*.md"): + file = open(f,"r") file_data = file.read() - f_md = open(f, "w") + f_md = open(path+"/"+f.split("/")[3], "w") + + f = f_dir+f process_data = "" if re.search("Scaffolding", f): From 76b2279fe5a6f8acbf873cfe351a827fecc28639 Mon Sep 17 00:00:00 2001 From: Robin de Rooij Date: Tue, 23 Aug 2022 16:17:03 +0200 Subject: [PATCH 3/5] Run gitbook generator again --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 84f8f4d5..3bd5195a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -22,6 +22,7 @@ jobs: cd docs python -m pip install -r requirements.txt make markdown + python3 generateGitbookMD.py - name: Set destination BRANCH_NAME for docs repo run: echo "BRANCH_NAME=Python-Reference-Updates-$(date +%s)" >> $GITHUB_ENV - name: Create pull request in terminusdb/terminusdb-docs From 9323fc5f86cf5be1450f7e205c08df24dc4f609a Mon Sep 17 00:00:00 2001 From: Robin de Rooij Date: Tue, 23 Aug 2022 16:20:24 +0200 Subject: [PATCH 4/5] use gitbook folder again --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3bd5195a..5ffd8a44 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -30,7 +30,7 @@ jobs: env: API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }} with: - source_folder: 'docs/build/markdown/.' + source_folder: 'docs/build/markdown/gitbook-md/.' destination_repo: 'terminusdb/terminusdb-docs' destination_folder: 'index/terminusx-db/reference-guides/python-client-reference' destination_base_branch: 'main' From 7634edba31947cbc8c190e4c28c4ff3c9f8d08db Mon Sep 17 00:00:00 2001 From: Robin de Rooij Date: Tue, 23 Aug 2022 16:40:33 +0200 Subject: [PATCH 5/5] Fixes --- .github/workflows/docs.yml | 1 + docs/source/Scaffolding_CLI_Tool.rst | 7 +++++++ 2 files changed, 8 insertions(+) create mode 100644 docs/source/Scaffolding_CLI_Tool.rst diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5ffd8a44..ed7a858d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -23,6 +23,7 @@ jobs: python -m pip install -r requirements.txt make markdown python3 generateGitbookMD.py + echo "# Python Client Reference" > build/markdown/gitbook-md/README.md - name: Set destination BRANCH_NAME for docs repo run: echo "BRANCH_NAME=Python-Reference-Updates-$(date +%s)" >> $GITHUB_ENV - name: Create pull request in terminusdb/terminusdb-docs diff --git a/docs/source/Scaffolding_CLI_Tool.rst b/docs/source/Scaffolding_CLI_Tool.rst new file mode 100644 index 00000000..c71f55cb --- /dev/null +++ b/docs/source/Scaffolding_CLI_Tool.rst @@ -0,0 +1,7 @@ +Scaffolding CLI Tool +==================== + + +.. click:: terminusdb_client.scripts.scripts:terminusdb + :prog: terminusdb + :nested: full