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

[dune] Simple rule to generate Stdlib's documentation. #9649

Merged
merged 1 commit into from Feb 28, 2019

Conversation

ejgallego
Copy link
Member

Ideally this will be handled by Dune's native library support, but
this could be useful for the likes of #9648.

I am not sure what should be done w.r.t. style files.

@ejgallego ejgallego added kind: documentation Additions or improvement to documentation. kind: infrastructure CI, build tools, development tools. labels Feb 25, 2019
@ejgallego ejgallego added this to the 8.10+beta1 milestone Feb 25, 2019
@ejgallego ejgallego requested a review from a team as a code owner February 25, 2019 08:35
@ejgallego ejgallego force-pushed the dune+coqdoc branch 2 times, most recently from 9a66ceb to a44bd0a Compare February 25, 2019 11:37
doc/stdlib/dune Outdated Show resolved Hide resolved
doc/stdlib/dune Outdated Show resolved Hide resolved
.gitlab-ci.yml Outdated Show resolved Hide resolved
doc/stdlib/dune Outdated Show resolved Hide resolved
@SkySkimmer
Copy link
Contributor

Compcert failed due to AbsInt/CompCert#275 (comment)
Should be fixed now

Copy link
Contributor

@SkySkimmer SkySkimmer left a comment

Choose a reason for hiding this comment

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

Not sure why bedrock failed
Linter error is spurious (#9653) and in the per-commit part, we can ignore it.

Do we merge without the .glob dependencies?

@ejgallego
Copy link
Member Author

Do we merge without the .glob dependencies?

Nope, let me fix that indeed, and rebase on top of #9648

@SkySkimmer
Copy link
Contributor

I'll let @Zimmi48 as dune secondary assign.

@ejgallego
Copy link
Member Author

Rebased, but I am not sure how to test the deploy job (@vbgl ?)

@vbgl
Copy link
Contributor

vbgl commented Feb 26, 2019

To test deploy jobs, I’ve manually started a CI pipeline with the appropriate credentials. I can do it for you if you think its necessary.

@ejgallego
Copy link
Member Author

To test deploy jobs, I’ve manually started a CI pipeline with the appropriate credentials. I can do it for you if you think its necessary.

Yup but that would overwrite the main Coq repos, right?

I guess I'll deploy to my own repos, and make the clone target a variable then.

@vbgl
Copy link
Contributor

vbgl commented Feb 26, 2019

It will not overwrite, but put you artifact in a separate directory (named as your branch: dune+coqdoc).

@ejgallego
Copy link
Member Author

It will not overwrite, but put you artifact in a separate directory (named as your branch: dune+coqdoc).

Ah Ok, cool then!

@ejgallego
Copy link
Member Author

I'd appreciate indeed if you can push a build to see whether that works.

@vbgl
Copy link
Contributor

vbgl commented Feb 26, 2019

Pipeline started. Result should appear in a few hours there: https://coq.github.io/doc/dune+coqdoc

@ejgallego
Copy link
Member Author

Pipeline started. Result should appear in a few hours there: https://coq.github.io/doc/dune+coqdoc

Muchas gracias @vbgl

Makefile.dune Outdated Show resolved Hide resolved
doc/stdlib/dune Outdated Show resolved Hide resolved
@Zimmi48 Zimmi48 self-assigned this Feb 26, 2019
@ejgallego
Copy link
Member Author

Will wait for the deploy build to finish before the rebase.

@Zimmi48
Copy link
Member

Zimmi48 commented Feb 26, 2019

There is also a problem with the artifacts (which should in principle make the deploy job fail): _build/default/doc/stdlib/html/ is not exported. See https://gitlab.com/coq/coq/-/jobs/167795044/artifacts/browse/_build/default/doc/.

@ejgallego
Copy link
Member Author

Well-spotted @Zimmi48 ahhh; indeed @SkySkimmer was right, I've added an extra CI job which should help consistency.

Fixed version uploaded, deploy job needs relaunch.

@vbgl
Copy link
Contributor

vbgl commented Feb 26, 2019

Pipeline launched for 7ba806b.

Ideally this will be handled by Dune's native library support, but
this could be useful for the likes of coq#9648.

I am not sure what should be done w.r.t. style files.
@vbgl
Copy link
Contributor

vbgl commented Feb 27, 2019

The deploy jobs went through (also for the last update). There are some issues with the documentation of the stdlib. E.g., at https://coq.github.io/doc/dune+coqdoc/stdlib/, in the “navigation” part, there is a dead link to genindex.html.

@ejgallego
Copy link
Member Author

The deploy jobs went through (also for the last update). There are some issues with the documentation of the stdlib. E.g., at https://coq.github.io/doc/dune+coqdoc/stdlib/, in the “navigation” part, there is a dead link to genindex.html.

It seems to work well here @vbgl , are you sure you were not looking to an older build [which had this problem]

So far, the docs looks pretty good to me.

@vbgl
Copy link
Contributor

vbgl commented Feb 28, 2019

My bad. It looks good indeed.

@Zimmi48 Zimmi48 merged commit 07ce258 into coq:master Feb 28, 2019
Emilio's PR automation moved this from Ready to Done Feb 28, 2019
Zimmi48 added a commit that referenced this pull request Feb 28, 2019
Reviewed-by: SkySkimmer
Reviewed-by: Zimmi48
Ack-by: rgrinberg
@ejgallego ejgallego deleted the dune+coqdoc branch February 28, 2019 11:16
@ejgallego
Copy link
Member Author

Thanks to all for the help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: documentation Additions or improvement to documentation. kind: infrastructure CI, build tools, development tools.
Projects
Emilio's PR
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

5 participants