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

docs: added auto-generation of documentation #27

Merged
s.o.h.luijkx merged 3 commits from docs/gen_documentation into dev 2025-11-19 17:15:17 +00:00
Conversation 13 Commits 3 Files Changed 5 +227 -1
s.o.h.luijkx commented 2025-11-19 12:54:39 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Added the functionality to automatically generate documentation.
Follow the instructions in the readme to generate the documentation webpages.
Execute this process to verify this merge request.

ref: N25B-270

Added the functionality to automatically generate documentation. Follow the instructions in the readme to generate the documentation webpages. Execute this process to verify this merge request. ref: N25B-270
0950726 commented 2025-11-19 15:39:16 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Also for Linux

### Linux & macOS
Also for Linux ```suggestion:-0+0 ### Linux & macOS ```
0950726 commented 2025-11-19 15:48:00 +00:00 (Migrated from git.science.uu.nl)
Copy Link

I suggest adding the following to the .gitignore. It will add the docs configuration file without the adding all the other generated files.

# Docs

docs/*
!docs/conf.py

Then you can also add the sphinx_rtd_theme to the docs configuration file and remove it from the README.

I suggest adding the following to the .gitignore. It will add the docs configuration file without the adding all the other generated files. ``` # Docs docs/* !docs/conf.py ``` Then you can also add the `sphinx_rtd_theme` to the docs configuration file and remove it from the README.
2584433 commented 2025-11-19 15:48:20 +00:00 (Migrated from git.science.uu.nl)
Copy Link
$env:PYTHONPATH="src"; sphinx-apidoc -F -o docs src/control_backend
```powershell $env:PYTHONPATH="src"; sphinx-apidoc -F -o docs src/control_backend ```
2584433 commented 2025-11-19 15:50:01 +00:00 (Migrated from git.science.uu.nl)
Copy Link

the bash for linux/mac does not work on windows, use the RI method.

the bash for linux/mac does not work on windows, use the RI method.
s.o.h.luijkx commented 2025-11-19 16:47:22 +00:00 (Migrated from git.science.uu.nl)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/ics/sp/2025/n25b/pepperplus-cb/-/merge_requests/27/diffs?diff_id=133863&start_sha=7e73baf8be2939a511d50530bd7b3d9e466f1995#8ec9a00bfd09b3190ac6b22251dbb1aa95a0579d_84_89)
s.o.h.luijkx commented 2025-11-19 16:47:23 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 1 commit

  • 8c209d3a - docs: conf.py is now included, sphinx is properly installed using uv

Compare with previous version

added 1 commit <ul><li>8c209d3a - docs: conf.py is now included, sphinx is properly installed using uv</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-cb/-/merge_requests/27/diffs?diff_id=133863&start_sha=7e73baf8be2939a511d50530bd7b3d9e466f1995)
0950726 commented 2025-11-19 16:52:25 +00:00 (Migrated from git.science.uu.nl)
Copy Link

resolved all threads

resolved all threads
0950726 commented 2025-11-19 16:52:28 +00:00 (Migrated from git.science.uu.nl)
Copy Link

approved this merge request

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

unapproved this merge request

unapproved this merge request
s.o.h.luijkx commented 2025-11-19 17:07:24 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 1 commit

  • 9cc44914 - chore: added to conf.py to correctly load modules for doc generation

Compare with previous version

added 1 commit <ul><li>9cc44914 - chore: added to conf.py to correctly load modules for doc generation</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-cb/-/merge_requests/27/diffs?diff_id=133872&start_sha=8c209d3adb9a61d83b760eee73e2af16ab8d53dc)
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:15:17 +00:00 (Migrated from git.science.uu.nl)
Copy Link

mentioned in commit 6025721866

mentioned in commit 6025721866aba39f449abfc1bbca62c26ab9c0fe
0950726 (Migrated from git.science.uu.nl) merged commit 6025721866 into dev 2025-11-19 17:15:17 +00:00
2584433 (Migrated from git.science.uu.nl) approved these changes 2026-02-02 13:29:06 +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-cb#27
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?