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.

Sign up for GitHub

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

Jump to bottom

GHA: add doc job #5349

Merged
merged 1 commit into from
Oct 21, 2024
Merged

GHA: add doc job #5349

merged 1 commit into from
Oct 21, 2024

Conversation

rjbou
Copy link
Collaborator

@rjbou rjbou commented Nov 11, 2022 •
edited
Loading

Generation of documentation with make doc

  • add a check on generated doc ?
  • add a check on index.html update when new modules is added

rjbou
rjbou commented Nov 17, 2022
View reviewed changes
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
rjbou
rjbou commented Nov 17, 2022
View reviewed changes
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
@rjbou rjbou force-pushed the gha-doc branch 2 times, most recently from e0051b5 to bf8b1f2 Compare July 6, 2023 14:33
@rjbou rjbou marked this pull request as draft July 10, 2024 14:17
@rjbou rjbou marked this pull request as ready for review August 9, 2024 13:56
@rjbou rjbou requested review from kit-ty-kate and dra27 August 9, 2024 13:56
dra27
dra27 reviewed Aug 30, 2024
View reviewed changes
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
@rjbou rjbou requested a review from dra27 August 30, 2024 17:29
dra27
dra27 approved these changes Aug 31, 2024
View reviewed changes
Copy link
Member

@dra27 dra27 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

main.yml has a testing hunk that needs reverting - rest are (optional) suggestions and otherwise good to go, thanks!

.github/workflows/main.yml Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
master_changes.md Outdated Show resolved Hide resolved
@kit-ty-kate kit-ty-kate added this to the 2.4.0~alpha1 milestone Sep 25, 2024
kit-ty-kate
kit-ty-kate reviewed Oct 17, 2024
View reviewed changes
Copy link
Member

@kit-ty-kate kit-ty-kate left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm otherwise

master_changes.md Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
.github/scripts/main/main.sh Outdated Show resolved Hide resolved
@rjbou rjbou mentioned this pull request Oct 17, 2024
Merged
@rjbou
gha: add doc job
f48edff 
* make doc: html, pages, manpages
* check that index.html is updated when a new module is added
* check that html files are generated: documentation (.md) and manpages
@rjbou rjbou mentioned this pull request Oct 21, 2024
Merged
@kit-ty-kate kit-ty-kate merged commit db2d5d8 into ocaml:master Oct 21, 2024
42 checks passed
@kit-ty-kate
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kit-ty-kate kit-ty-kate kit-ty-kate approved these changes

@dra27 dra27 Awaiting requested review from dra27

Assignees
No one assigned
Labels
AREA: DOCUMENTATION AREA:TEST PR: WAITING FOR REVIEW
Projects
None yet
Milestone
2.4.0~alpha1
Development

Successfully merging this pull request may close these issues.
3 participants
@rjbou @kit-ty-kate @dra27