pepperplus/pepperplus-ri
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: added auto-generation of documentation #10

Merged
s.o.h.luijkx merged 4 commits from docs/gen_documentation into dev 2025-11-19 17:14:36 +00:00
Conversation 10 Commits 4 Files Changed 5 +223 -1
s.o.h.luijkx commented 2025-11-19 12:59:25 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Added auto generation of documentation functionality.
Follow the steps in the readme to generate the documentation web pages.
Execute these steps and verify correct behaviour.

ref: N25B-270

Added auto generation of documentation functionality. Follow the steps in the readme to generate the documentation web pages. Execute these steps and verify correct behaviour. ref: N25B-270
2584433 commented 2025-11-19 16:39:36 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Same comments as the CB auto-generation.

$env:PYTHONPATH="src"; sphinx-apidoc -F -o docs src/robot_interface

is the comment for windows.

Same comments as the CB auto-generation. ``` $env:PYTHONPATH="src"; sphinx-apidoc -F -o docs src/robot_interface ``` is the comment for windows.
2584433 commented 2025-11-19 16:55:43 +00:00 (Migrated from git.science.uu.nl)
Copy Link

import os
import sys
sys.path.insert(0, os.path.abspath("../src"))

in conf file

import os import sys sys.path.insert(0, os.path.abspath("../src")) in conf file
2584433 commented 2025-11-19 16:58:08 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 1 commit

  • 1c9467d0 - fix: conf includes correct path

Compare with previous version

added 1 commit <ul><li>1c9467d0 - fix: conf includes correct path</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/10/diffs?diff_id=133868&start_sha=9dd39d2048fd7b62bb61b0c45dc7e0d8e4ce6bf3)
s.o.h.luijkx commented 2025-11-19 16:59:39 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 1 commit

Compare with previous version

added 1 commit <ul><li>a0a8ad26 - docs: changed readme</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/10/diffs?diff_id=133870&start_sha=1c9467d03a285aa03cc93ba4bf82547d59fd7eda)
0950726 commented 2025-11-19 17:06:22 +00:00 (Migrated from git.science.uu.nl)
Copy Link

We needed a specific version of this for Python 2, right?

sphinx<2
We needed a specific version of this for Python 2, right? ```suggestion:-0+0 sphinx<2 ```
s.o.h.luijkx commented 2025-11-19 17:11:32 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 1 commit

Compare with previous version

added 1 commit <ul><li>cec29f62 - chore: updated .gitignore</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/10/diffs?diff_id=133874&start_sha=a0a8ad2689f4087313201bfaf794a138c30d0e4f)
0950726 commented 2025-11-19 17:13:48 +00:00 (Migrated from git.science.uu.nl)
Copy Link

resolved all threads

resolved all threads
2584433 commented 2025-11-19 17:14:10 +00:00 (Migrated from git.science.uu.nl)
Copy Link

approved this merge request

approved this merge request
0950726 commented 2025-11-19 17:14:36 +00:00 (Migrated from git.science.uu.nl)
Copy Link

mentioned in commit 1e3531ac6e

mentioned in commit 1e3531ac6e221dae7057d39047dbc0930a825d0d
0950726 (Migrated from git.science.uu.nl) merged commit 1e3531ac6e into dev 2025-11-19 17:14:36 +00:00
2584433 (Migrated from git.science.uu.nl) approved these changes 2026-02-02 13:26:45 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
2584433
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
kasper twirre pepperplus
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: pepperplus/pepperplus-ri#10
Delete Branch "docs/gen_documentation"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?