Merge branch 'py-docs' of github.com:photonvision/photonvision into py-docs

This commit is contained in:
samfreund
2025-04-12 22:30:08 -05:00
2 changed files with 7 additions and 20 deletions

View File

@@ -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
@@ -82,16 +82,17 @@ 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
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
@@ -104,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 }}

View File

@@ -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 the full PhotonVision documentation visit [docs.photonvision.org](https://docs.photonvision.org).