Merge pull request #28 from rticommunity/py_sdk

Deploy docs automation and link update

Author: rtidgreenberg

.github/workflows/deploy-docs.yml

@@ -0,0 +1,46 @@
+name: Deploy Sphinx Docs
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx-rtd-theme myst-parser
+          pip install -e python/
+
+      - name: Build docs
+        run: sphinx-build -b html python/docs python/docs/_build/html
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: python/docs/_build/html
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

python/README.md

@@ -40,6 +40,18 @@ python run_autopilot.py
 
 The autopilot component starts 18 UMAA services and runs until you press `Ctrl+C`.
 
+---
+
+## Documentation
+
+- [Getting Started](docs/getting-started.md) — environment setup, first component
+- [Building a Component](docs/building-a-component.md) — step-by-step tutorial
+- [QoS Configuration](docs/qos-configuration.md) — AssignerQoS, topic filter rules, profiles
+- [Vendor Interoperability](docs/vendor-interoperability.md) — DDS-XTYPES compliance, Cyclone DDS interop
+- [Troubleshooting](docs/troubleshooting.md) — common issues and solutions
+- [Changelog](docs/changelog.md)
+
+Full API reference (autodoc): **[rticommunity.github.io/rticonnextdds-usecases-umaa](https://rticommunity.github.io/rticonnextdds-usecases-umaa/)**
 
 To build the docs locally: