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

Introduce documentation generator #20

Merged
0950726 merged 2 commits from docs/generate-html into dev 2025-11-19 09:30:54 +00:00
Conversation 11 Commits 2 Files Changed 4 +228 -1
0950726 commented 2025-11-18 09:42:59 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Added a dependency, the typedoc utility can generate HTML from documentation in our source code.

To verify:

  • Run the command in the README (will give some warnings)
  • The /docs/index.html file can be opened in a browser
  • Check whether the generated docs make sense

ref: N25B-288

Added a dependency, the `typedoc` utility can generate HTML from documentation in our source code. To verify: - [x] Run the command in the README (will give some warnings) - [x] The `/docs/index.html` file can be opened in a browser - [x] Check whether the generated docs make sense ref: N25B-288
0950726 commented 2025-11-18 09:42:59 +00:00 (Migrated from git.science.uu.nl)
Copy Link

assigned to @0950726

assigned to @0950726
9828273 commented 2025-11-18 10:39:42 +00:00 (Migrated from git.science.uu.nl)
Copy Link

requested review from @9828273

requested review from @9828273
0950726 commented 2025-11-18 10:45:13 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 1 commit

Compare with previous version

added 1 commit <ul><li>eabc7c8b - docs: fix run command</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-ui/-/merge_requests/20/diffs?diff_id=133729&start_sha=000d221538be54f423b85da3755184d3203ea409)
9828273 commented 2025-11-18 10:47:05 +00:00 (Migrated from git.science.uu.nl)
Copy Link

marked the checklist item Run the command in the README (will give some warnings) as completed

marked the checklist item **Run the command in the README (will give some warnings)** as completed
9828273 commented 2025-11-18 10:47:07 +00:00 (Migrated from git.science.uu.nl)
Copy Link

marked the checklist item The /docs/index.html file can be opened in a browser as completed

marked the checklist item **The `/docs/index.html` file can be opened in a browser** as completed
9828273 commented 2025-11-18 10:47:47 +00:00 (Migrated from git.science.uu.nl)
Copy Link

marked the checklist item Check whether the generated docs make sense as completed

marked the checklist item **Check whether the generated docs make sense** as completed
9828273 commented 2025-11-18 10:47:51 +00:00 (Migrated from git.science.uu.nl)
Copy Link

approved this merge request

approved this merge request
2584433 commented 2025-11-19 09:30:27 +00:00 (Migrated from git.science.uu.nl)
Copy Link

approved this merge request

approved this merge request
2584433 commented 2025-11-19 09:30:54 +00:00 (Migrated from git.science.uu.nl)
Copy Link

mentioned in commit 4f7c730916

mentioned in commit 4f7c730916ba80285325441be07ad6e33a75c36f
2584433 (Migrated from git.science.uu.nl) merged commit 4f7c730916 into dev 2025-11-19 09:30:55 +00:00
9828273 (Migrated from git.science.uu.nl) approved these changes 2026-02-02 13:31:16 +00:00
2584433 (Migrated from git.science.uu.nl) approved these changes 2026-02-02 13:31:16 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
9828273
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-ui#20
Delete Branch "docs/generate-html"

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?