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

Docs (rustdoc, odoc): build and publish to gh-pages (via CI) #361

Merged
merged 8 commits into from
Nov 20, 2023
Merged

Docs (rustdoc, odoc): build and publish to gh-pages (via CI) #361

merged 8 commits into from
Nov 20, 2023

Conversation

W95Psp
Copy link
Collaborator

@W95Psp W95Psp commented Nov 15, 2023 •
edited
Loading

This PR adds build for rustdoc and odoc (ocaml's doc tool), and bundles documentation in one index.html ToC.
It also adds CI for deploying to GH Pages

@W95Psp W95Psp marked this pull request as ready for review November 15, 2023 15:15
@W95Psp W95Psp changed the title Doc Docs (rustdoc, odoc): build and publish to gh-pages (via CI) Nov 15, 2023
franziskuskiefer
franziskuskiefer requested changes Nov 17, 2023
View reviewed changes
Copy link
Member

@franziskuskiefer franziskuskiefer left a comment

Choose a reason for hiding this comment

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

Generally lgtm with a few nits.

engine/doc/dune Outdated Show resolved Hide resolved
engine/doc/index.mld Outdated Show resolved Hide resolved
.github/workflows/gh_pages.yml Outdated Show resolved Hide resolved
.github/workflows/gh_pages.yml Outdated Show resolved Hide resolved
@W95Psp W95Psp enabled auto-merge November 17, 2023 07:35
@W95Psp
Copy link
Collaborator Author

W95Psp commented Nov 17, 2023

Thanks, I didn't know about those deploy actions to GH Pages, they look nice! :)

@W95Psp W95Psp disabled auto-merge November 17, 2023 08:02
franziskuskiefer
franziskuskiefer approved these changes Nov 20, 2023
View reviewed changes
Copy link
Member

@franziskuskiefer franziskuskiefer left a comment

Choose a reason for hiding this comment

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

Thanks

@franziskuskiefer franziskuskiefer added this pull request to the merge queue Nov 20, 2023
Merged via the queue into main with commit e1d0dc8 Nov 20, 2023
9 checks passed
@franziskuskiefer franziskuskiefer deleted the doc branch November 20, 2023 06:53
@W95Psp W95Psp mentioned this pull request Nov 20, 2023
Merged
@W95Psp W95Psp mentioned this pull request May 13, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@franziskuskiefer franziskuskiefer franziskuskiefer approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@W95Psp @franziskuskiefer