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

Deploy the documentation of the main branch #818

Merged
merged 2 commits into from
Sep 19, 2023
Merged

Deploy the documentation of the main branch #818

merged 2 commits into from
Sep 19, 2023

Conversation

Halbaroth
Copy link
Collaborator

@Halbaroth Halbaroth commented Sep 13, 2023 •
edited
Loading

This PR should solve #693.

As soon as the opam CI accepts our packages, I will push v2.5.x on the branch main.
We have to backport this patch on v2.5.x otherwise the documentation won't be deployed while pushing on main.

@Halbaroth Halbaroth added this to the 2.6.0 milestone Sep 13, 2023
@Halbaroth
Copy link
Collaborator Author

Alt-Ergo 2.5.0 is on opam!

@bclement-ocp
Copy link
Collaborator

Are we sure we want to use main for this? Since 2.5.0 is already released I think it would be better to disable the automatic GH page generation for now and manually generate the doc for 2.5.0 (using the same commands as in the workflow) so that we have a bit more time to think about what we want to do. In particular, it would be great to keep the doc for old versions available.

@Halbaroth
Copy link
Collaborator Author

Halbaroth commented Sep 13, 2023 •
edited
Loading

Why do you want to keep old documentations here? Users can run odig to retrieve old documentations.

@bclement-ocp
Copy link
Collaborator

It is a good practice to provide access to the documentation for all released versions (or recent-ish released versions) for users that do not use the latest release and do not have the sources readily available and want to access the documentation corresponding to their version of Alt-Ergo. Moreover, the Sphinx documentation that is built by the GH pages is not available through odig.

We used to have old versions (at least one) of the documentation, but the link to the doc for version 2.4.0 seems to be broken: https://ocamlpro.github.io/alt-ergo/API/index.html

(As an aside: OPAM is able to provide docs, see e.g. https://ocaml.org/p/cmdliner/latest/doc/index.html , but it looks like ours does not get built, we should investigate this sometime as well)

bclement-ocp
bclement-ocp approved these changes Sep 14, 2023
View reviewed changes
Copy link
Collaborator

@bclement-ocp bclement-ocp left a comment

Choose a reason for hiding this comment

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

After offline discussion: let's merge this and put it in 2.5.1 for now, we will figure out the issues with multiple versions later.

.github/workflows/documentation.yml Outdated
@@ -19,7 +19,7 @@ env:
jobs:
# For any push and PR, build the documentation from the ocaml comments
# If this build fails, the documentation workflow stops
# If it succed, an artifact is made with the generated documentation
# If it succeed, an artifact is made with the generated documentation
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# If it succeed, an artifact is made with the generated documentation
# If it succeeds, an artifact is made with the generated documentation

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is an incremental spelling correction! :D

.github/workflows/documentation.yml Outdated
@@ -95,7 +95,7 @@ jobs:

# On PR, or push on next/main, build the sphinx general documentation
# If this build fails, the documentation workflow stops
# If it succed, an artifact is made with the generated documentation
# If it succeed, an artifact is made with the generated documentation
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# If it succeed, an artifact is made with the generated documentation
# If it succeeds, an artifact is made with the generated documentation

@Halbaroth Halbaroth merged commit 2d7d271 into OCamlPro:next Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bclement-ocp bclement-ocp bclement-ocp approved these changes

Assignees
No one assigned
Labels
backporting documentation
Projects
None yet
Milestone
2.6.0
Development

Successfully merging this pull request may close these issues.
2 participants
@Halbaroth @bclement-ocp