Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation #228

Merged
merged 25 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
9cd63d0
Setup basic theme
urfeex Dec 4, 2024
f7c3c39
Update welcome page with a one-liner
urfeex Dec 4, 2024
e03a97b
Update installation / build instructions
urfeex Dec 4, 2024
58648e9
Update ScriptSender documentation with example
urfeex Dec 4, 2024
c8abdc5
Update rtde client documentation
urfeex Dec 4, 2024
a35e82e
Add ci job for building the docs
urfeex Dec 4, 2024
6a51e34
Remove rosdoc_lite check
urfeex Dec 5, 2024
e3e8cdc
Update dashboard client documentation
urfeex Dec 5, 2024
c0ac212
Add todo extension
urfeex Dec 5, 2024
bbc536f
Add script command interface documentation
urfeex Dec 5, 2024
2635c61
doc-CI: Treat warnings as errors
urfeex Dec 5, 2024
7896c7d
Add reverse_interface docuemtnation
urfeex Dec 6, 2024
33b5270
Add trajectory_point_interface documentation
urfeex Dec 6, 2024
6a099c5
Move UrDriver component description to own file
urfeex Dec 9, 2024
e55aeee
Architecture overview graph
urfeex Dec 9, 2024
0b2b2c7
Update ur_theme
urfeex Dec 13, 2024
ed96360
Apply suggestions from code review
urfeex Dec 16, 2024
5918c6b
Clarify usage of dashboard client's command functions
urfeex Dec 16, 2024
d2b4900
Add and fix comments to control modes
urfeex Dec 16, 2024
8b9fb9f
Fix writing of PolyScope
urfeex Dec 16, 2024
d9a22c4
Add about PolyScope X compatibility
urfeex Dec 16, 2024
32e2c0d
Fix timeout for script sender example
urfeex Dec 17, 2024
8d60d45
Added break_2 info to PolyScope version compatability page
urrsk Dec 17, 2024
bb35129
fix max version before matrix support
urfeex Dec 17, 2024
6748694
Clarify max version and tag in version compatibility
urfeex Dec 18, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions .github/actions/rosdoc_lite_action/Dockerfile

This file was deleted.

6 changes: 0 additions & 6 deletions .github/actions/rosdoc_lite_action/action.yml

This file was deleted.

20 changes: 0 additions & 20 deletions .github/actions/rosdoc_lite_action/entrypoint.sh

This file was deleted.

8 changes: 1 addition & 7 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,5 @@ jobs:
run: |
.github/helpers/check_urls.sh \
-d ".git build CMakeModules debian" \
-f "package.xml architecture_coarse.svg dataflow.graphml start_ursim.sh" \
-f "package.xml urcl_architecture.svg trajectory_interface.svg dataflow.graphml start_ursim.sh" \
-p "vnc\.html opensource\.org\/licenses\/BSD-3-Clause kernel\.org\/pub\/linux\/kernel"

rosdoc_lite_check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ./.github/actions/rosdoc_lite_action
30 changes: 30 additions & 0 deletions .github/workflows/sphinx_build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: "Build documentation"
on:
workflow_dispatch:
pull_request:
push:
branches:
- main
schedule:
- cron: '38 2 * * *'

jobs:
docs:
runs-on: ubuntu-latest
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
cache: 'pip'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r doc_requirements.txt
- name: Build documentation
run: |
sphinx-build -W -b html doc _doc_build
Loading
Loading