From 21b630c7544230468316696609815c050855de57 Mon Sep 17 00:00:00 2001 From: hwelch-fle <91618355+hwelch-fle@users.noreply.github.com> Date: Mon, 1 May 2023 15:39:48 -0400 Subject: [PATCH 1/7] Update pdoc.yml --- .github/workflows/pdoc.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/pdoc.yml b/.github/workflows/pdoc.yml index de8fa54..f8ba7ba 100644 --- a/.github/workflows/pdoc.yml +++ b/.github/workflows/pdoc.yml @@ -24,11 +24,13 @@ jobs: python-version: '3.11' # ADJUST THIS: install all dependencies (including pdoc) - #- run: pip install --upgrade pip + - run: pip install -e + - run: pip install --upgrade pip - run: pip install pdoc # ADJUST THIS: build your documentation into docs/. # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. - - run: pdoc -d markdown -o docs/ plankapy.py + - run: tail ../../plankapy.py + - run: pdoc -d markdown -o ../../docs ../../plankapy.py - uses: actions/upload-pages-artifact@v1 with: From c7181579e2f9d4eba8dfa84b7de4b96a3d2753e2 Mon Sep 17 00:00:00 2001 From: hwelch-fle <91618355+hwelch-fle@users.noreply.github.com> Date: Mon, 1 May 2023 15:42:28 -0400 Subject: [PATCH 2/7] Update pdoc.yml --- .github/workflows/pdoc.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/pdoc.yml b/.github/workflows/pdoc.yml index f8ba7ba..7b5102a 100644 --- a/.github/workflows/pdoc.yml +++ b/.github/workflows/pdoc.yml @@ -24,12 +24,13 @@ jobs: python-version: '3.11' # ADJUST THIS: install all dependencies (including pdoc) - - run: pip install -e + - run: pip install -e . - run: pip install --upgrade pip - run: pip install pdoc # ADJUST THIS: build your documentation into docs/. # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. - - run: tail ../../plankapy.py + - run: cd ../../ + - run: ls -a - run: pdoc -d markdown -o ../../docs ../../plankapy.py - uses: actions/upload-pages-artifact@v1 From b1d88f6b1cc21646bc2bcf37b218a8f65301b0ce Mon Sep 17 00:00:00 2001 From: hwelch-fle <91618355+hwelch-fle@users.noreply.github.com> Date: Mon, 1 May 2023 15:43:36 -0400 Subject: [PATCH 3/7] Update pdoc.yml --- .github/workflows/pdoc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/pdoc.yml b/.github/workflows/pdoc.yml index 7b5102a..613ff6d 100644 --- a/.github/workflows/pdoc.yml +++ b/.github/workflows/pdoc.yml @@ -24,8 +24,8 @@ jobs: python-version: '3.11' # ADJUST THIS: install all dependencies (including pdoc) - - run: pip install -e . - - run: pip install --upgrade pip + #- run: pip install -e . + #- run: pip install --upgrade pip - run: pip install pdoc # ADJUST THIS: build your documentation into docs/. # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. From bd6de248a66ff1f15e06d652f00091f552450845 Mon Sep 17 00:00:00 2001 From: hwelch-fle <91618355+hwelch-fle@users.noreply.github.com> Date: Mon, 1 May 2023 15:45:38 -0400 Subject: [PATCH 4/7] Update pdoc.yml --- .github/workflows/pdoc.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/pdoc.yml b/.github/workflows/pdoc.yml index 613ff6d..7251016 100644 --- a/.github/workflows/pdoc.yml +++ b/.github/workflows/pdoc.yml @@ -29,13 +29,11 @@ jobs: - run: pip install pdoc # ADJUST THIS: build your documentation into docs/. # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. - - run: cd ../../ - - run: ls -a - - run: pdoc -d markdown -o ../../docs ../../plankapy.py + - run: python3 -m pdoc -d markdown -o ../../docs ../../plankapy.py - uses: actions/upload-pages-artifact@v1 with: - path: docs/ + path: ../../docs # Deploy the artifact to GitHub pages. # This is a separate job so that only actions/deploy-pages has the necessary permissions. From a97b606664703aaabfbb06a4754cd70f01c15894 Mon Sep 17 00:00:00 2001 From: hwelch-fle <91618355+hwelch-fle@users.noreply.github.com> Date: Mon, 1 May 2023 15:46:57 -0400 Subject: [PATCH 5/7] Update pdoc.yml --- .github/workflows/pdoc.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/pdoc.yml b/.github/workflows/pdoc.yml index 7251016..a6e273f 100644 --- a/.github/workflows/pdoc.yml +++ b/.github/workflows/pdoc.yml @@ -27,6 +27,8 @@ jobs: #- run: pip install -e . #- run: pip install --upgrade pip - run: pip install pdoc + - run: pip install requests + - run: pip install json # ADJUST THIS: build your documentation into docs/. # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. - run: python3 -m pdoc -d markdown -o ../../docs ../../plankapy.py From 5d4f31da265dd6069a7ba3f9a9ade6096245cee5 Mon Sep 17 00:00:00 2001 From: hwelch-fle <91618355+hwelch-fle@users.noreply.github.com> Date: Mon, 1 May 2023 15:48:28 -0400 Subject: [PATCH 6/7] Update pdoc.yml --- .github/workflows/pdoc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pdoc.yml b/.github/workflows/pdoc.yml index a6e273f..903c4b0 100644 --- a/.github/workflows/pdoc.yml +++ b/.github/workflows/pdoc.yml @@ -28,7 +28,7 @@ jobs: #- run: pip install --upgrade pip - run: pip install pdoc - run: pip install requests - - run: pip install json + #- run: pip install json # ADJUST THIS: build your documentation into docs/. # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. - run: python3 -m pdoc -d markdown -o ../../docs ../../plankapy.py From 7085efaf93ff65829d37c8b5fdc9d3a4f9e8e5fc Mon Sep 17 00:00:00 2001 From: hwelch-fle <91618355+hwelch-fle@users.noreply.github.com> Date: Mon, 1 May 2023 15:50:44 -0400 Subject: [PATCH 7/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5011231..bc08fd0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ # plankapy A python 3 based API for controlling a self-hosted Planka instance -[Docs](https://hwelch-fle.github.io) +[Docs](https://hwelch-fle.github.io/plankapy/plankapy.html)