Skip to content

Commit 6bc1553

Browse files
authored
Updated documentation (#228)
* Update sphinx theme * Update welcome page with a one-liner * Update installation / build instructions * Update ScriptSender documentation with example * Update rtde client documentation * Add ci job for building the docs * Update dashboard client documentation * Add script command interface documentation * Add reverse_interface documentation * Add trajectory_point_interface documentation * Move UrDriver component description to own file * Update architecture overview graph * Add notes about PolyScope X compatibility
1 parent 6d49187 commit 6bc1553

30 files changed

+1445
-1748
lines changed

.github/actions/rosdoc_lite_action/Dockerfile

Lines changed: 0 additions & 8 deletions
This file was deleted.

.github/actions/rosdoc_lite_action/action.yml

Lines changed: 0 additions & 6 deletions
This file was deleted.

.github/actions/rosdoc_lite_action/entrypoint.sh

Lines changed: 0 additions & 20 deletions
This file was deleted.

.github/workflows/ci.yml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -107,11 +107,5 @@ jobs:
107107
run: |
108108
.github/helpers/check_urls.sh \
109109
-d ".git build CMakeModules debian" \
110-
-f "package.xml architecture_coarse.svg dataflow.graphml start_ursim.sh" \
110+
-f "package.xml urcl_architecture.svg trajectory_interface.svg dataflow.graphml start_ursim.sh" \
111111
-p "vnc\.html opensource\.org\/licenses\/BSD-3-Clause kernel\.org\/pub\/linux\/kernel"
112-
113-
rosdoc_lite_check:
114-
runs-on: ubuntu-latest
115-
steps:
116-
- uses: actions/checkout@v4
117-
- uses: ./.github/actions/rosdoc_lite_action

.github/workflows/sphinx_build.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: "Build documentation"
3+
on:
4+
workflow_dispatch:
5+
pull_request:
6+
push:
7+
branches:
8+
- main
9+
schedule:
10+
- cron: '38 2 * * *'
11+
12+
jobs:
13+
docs:
14+
runs-on: ubuntu-latest
15+
permissions:
16+
contents: write
17+
concurrency:
18+
group: ${{ github.workflow }}-${{ github.ref }}
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: actions/setup-python@v5
22+
with:
23+
cache: 'pip'
24+
- name: Install dependencies
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install -r doc_requirements.txt
28+
- name: Build documentation
29+
run: |
30+
sphinx-build -W -b html doc _doc_build

0 commit comments

Comments
 (0)