Add a github action to run doc-gen #5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Note that we also have to bump the lean/mathlib version, as doc-gen requires a recent version. I haven't checked whether this breaks anything.
collares
reviewed
Jul 27, 2022
Co-authored-by: Mauricio Collares <[email protected]>
collares
reviewed
Jul 28, 2022
.github/workflows/lean_doc.yml
Outdated
| cd doc-gen | ||
| lean -v | ||
| # the json and diagnostics are emitted on stdout, but the json is always the last (very long) line. | ||
| lean src/entrypoint.lean > export.json || true |
There was a problem hiding this comment.
Suggested change
| lean src/entrypoint.lean > export.json || true | |
| lean --run src/entrypoint.lean > export.json || true |
There was a problem hiding this comment.
I think that's now overkill: this is what I use elsewhere:
eric-wieser
commented
Jul 28, 2022
.github/workflows/lean_doc.yml
Outdated
| cd doc-gen | ||
| lean -v | ||
| # the json and diagnostics are emitted on stdout, but the json is always the last (very long) line. | ||
| lean src/entrypoint.lean > export.json || true |
There was a problem hiding this comment.
I think that's now overkill: this is what I use elsewhere:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note that we also have to bump the lean/mathlib version, as doc-gen requires a recent version.
I haven't checked whether this breaks anything.
Note that this produces a handful of errors, as you have files that define the same name in the global namespace, which makes it impossible to import these at the same time. Wrapping each file in
namespace «2021» ... end «2019»etc would probably fix this.If you don't do that, it just means that half these definitions will be missing from the docs.