From 462a2aa629a3be6e6604422d4ae55e0d549a0aed Mon Sep 17 00:00:00 2001 From: Sam Freund Date: Sat, 12 Apr 2025 17:16:07 -0500 Subject: [PATCH 1/5] Update photon-api-docs.yml --- .github/workflows/photon-api-docs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/photon-api-docs.yml b/.github/workflows/photon-api-docs.yml index 12613621f..308fdec0e 100644 --- a/.github/workflows/photon-api-docs.yml +++ b/.github/workflows/photon-api-docs.yml @@ -86,12 +86,13 @@ jobs: - name: Build MkDocs site run: mkdocs build --clean + working-directory: photon-lib/py - name: Upload built site as artifact uses: actions/upload-artifact@v4 with: name: docs-python - path: site/ + path: photon-lib/py/site/ publish_api_docs: name: Publish API Docs From 7c6bab1dfa10ca8b765edb6312b390d8b16f01b3 Mon Sep 17 00:00:00 2001 From: Sam Freund Date: Sat, 12 Apr 2025 17:17:21 -0500 Subject: [PATCH 2/5] Update photon-api-docs.yml --- .github/workflows/photon-api-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/photon-api-docs.yml b/.github/workflows/photon-api-docs.yml index 308fdec0e..21b810021 100644 --- a/.github/workflows/photon-api-docs.yml +++ b/.github/workflows/photon-api-docs.yml @@ -82,7 +82,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install mkdocs mkdocs-material + pip install mkdocs mkdocs-material mkdocstrings[python] - name: Build MkDocs site run: mkdocs build --clean From 6d816b5053d2d0a9334f06844b5b4b21bd72c39a Mon Sep 17 00:00:00 2001 From: Sam Freund Date: Sat, 12 Apr 2025 17:19:46 -0500 Subject: [PATCH 3/5] Update photon-api-docs.yml --- .github/workflows/photon-api-docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/photon-api-docs.yml b/.github/workflows/photon-api-docs.yml index 21b810021..0db159882 100644 --- a/.github/workflows/photon-api-docs.yml +++ b/.github/workflows/photon-api-docs.yml @@ -43,7 +43,7 @@ jobs: path: photon-client/dist/ run_java_cpp_docs: - name: Build API Docs For Java and C++ + name: Build Java and C++ API Docs runs-on: "ubuntu-22.04" steps: - name: Checkout code @@ -105,7 +105,7 @@ jobs: pattern: docs-* - run: find . - name: Publish Docs To Development - if: github.ref == 'refs/heads/main' + # if: github.ref == 'refs/heads/main' uses: up9cloud/action-rsync@v1.4 env: HOST: ${{ secrets.WEBMASTER_SSH_HOST }} From 3c73b68ba38c292c83164cca346400c66116967f Mon Sep 17 00:00:00 2001 From: Sam Freund Date: Sat, 12 Apr 2025 17:33:37 -0500 Subject: [PATCH 4/5] Update index.md --- photon-lib/py/docs/index.md | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/photon-lib/py/docs/index.md b/photon-lib/py/docs/index.md index 000ea3455..619103f67 100644 --- a/photon-lib/py/docs/index.md +++ b/photon-lib/py/docs/index.md @@ -1,17 +1,3 @@ -# Welcome to MkDocs +# PhotonLib Python Docs -For full documentation visit [mkdocs.org](https://www.mkdocs.org). - -## Commands - -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +For full documentation visit [docs.photonvision.org](https://docs.photonvision.org). From 55303ccd9cc54ccdfc3a6fe41ba6bc6fed46ca88 Mon Sep 17 00:00:00 2001 From: Sam Freund Date: Sat, 12 Apr 2025 17:33:57 -0500 Subject: [PATCH 5/5] Update index.md --- photon-lib/py/docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/photon-lib/py/docs/index.md b/photon-lib/py/docs/index.md index 619103f67..06545b8e2 100644 --- a/photon-lib/py/docs/index.md +++ b/photon-lib/py/docs/index.md @@ -1,3 +1,3 @@ # PhotonLib Python Docs -For full documentation visit [docs.photonvision.org](https://docs.photonvision.org). +For the full PhotonVision documentation visit [docs.photonvision.org](https://docs.photonvision.org).