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.

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

Compatibility with odoc.2.4.1 #128

Merged
merged 1 commit into from
Mar 26, 2024
Merged

Compatibility with odoc.2.4.1 #128

merged 1 commit into from
Mar 26, 2024

Conversation

gpetiot
Copy link

@gpetiot gpetiot commented Sep 27, 2023

odoc.2.3.0 should have been released already, should be there soon.

@sabine can this be moved to the staging branch once odoc.2.3.0 is released? (the CI pipeline needs to pin this version)

@gpetiot
Copy link
Author

gpetiot commented Oct 3, 2023

@sabine odoc.2.3.0 has now been released on opam. I cannot restart the CI but everything works locally with the new release.

@sabine
Copy link
Collaborator

sabine commented Oct 3, 2023

CI restarted. There needs to be a corresponding PR on ocaml-docs-ci to pin odoc indeed. Ideally referencing back to this one, for clarity.

@gpetiot
Copy link
Author

gpetiot commented Oct 3, 2023

I opened a PR on ocaml-docs-ci: ocurrent/ocaml-docs-ci#154

@tmcgilchrist
Copy link
Collaborator

What co-ordination is required for the deployment of this change with docs-ci and ocaml.org?
Is ocaml.org backwards compatible with odoc.2.2.0 and 2.3.0 formats?

@tmcgilchrist
Copy link
Collaborator

@gpetiot Could you update both PRs to use 2.3.1 that includes some bug fixes?

@gpetiot
Copy link
Author

gpetiot commented Oct 31, 2023

I updated this PR and ocurrent/ocaml-docs-ci#163 to use odoc.2.3.1

@gpetiot gpetiot changed the title Compatibility with odoc.2.3.0 Compatibility with odoc.2.3.1 Oct 31, 2023
@gpetiot gpetiot changed the title Compatibility with odoc.2.3.1 Compatibility with odoc.2.4.0 Jan 12, 2024
@gpetiot
Copy link
Author

gpetiot commented Jan 12, 2024

@sabine @EmileTrotignon I updated the PR for odoc.2.4.0 (the only change is the integration of ocaml/odoc#949)

| `SourceLocationInternal (parent, name) ->
LocalName.to_string name :: full_name_aux (parent :> Identifier.t)
| `SourcePage (parent, name) ->
name :: full_name_aux (parent :> Identifier.t)

Choose a reason for hiding this comment

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

This is fine, although a fullname function is now shipped by odoc, so it could be deleted.

@gpetiot
Copy link
Author

gpetiot commented Jan 19, 2024

Let's wait for odoc.2.4.1 to be available on opam, as it's apparently necessary to have eio compile.

@gpetiot gpetiot changed the title Compatibility with odoc.2.4.0 Compatibility with odoc.2.4.1 Feb 12, 2024
@gpetiot
Copy link
Author

gpetiot commented Feb 13, 2024

@sabine the CI is passing (except the experimental ones) on this PR, can we push it to the staging branch?

sabine added a commit that referenced this pull request Feb 13, 2024
@sabine
Copy link
Collaborator

sabine commented Feb 13, 2024

It's now on staging and will be picked up by staging.docs.ci.ocamllabs.io!

@sabine
Copy link
Collaborator

sabine commented Mar 26, 2024

Seems to be okay on staging.docs.ci.ocamllabs.io, so merging this.

It will take a few days for docs.ci.ocaml.org to build a sufficient number of packages, so that we can be sure the deployment worked.

@sabine sabine merged commit dc54397 into ocaml-doc:main Mar 26, 2024
2 of 3 checks passed
@gpetiot gpetiot deleted the odoc.2.3.0 branch March 26, 2024 18:26
@art-w
Copy link

art-w commented Mar 27, 2024

Did this accidentally change some urls? It looks like documentation is generated on the server as usual, but I get a 404 on every package doc on ocaml.org :(

(... edit: to clarify, I have no idea if this PR is related or if something else happened!)

@sabine
Copy link
Collaborator

sabine commented Mar 27, 2024

This seems related but unintended because the documentation pipeline should be building docs in a new, non-live epoch. I passed this on to Mark.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants