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

Update dependencies to support doc-gen4 #12

Merged
merged 2 commits into from
May 22, 2024
Merged

Update dependencies to support doc-gen4 #12

merged 2 commits into from
May 22, 2024

Conversation

mjdemedeiros
Copy link
Collaborator

@mjdemedeiros mjdemedeiros commented May 22, 2024 •
edited
Loading

  • update dependencies to include doc-gen4
  • generate stub documentation and point website to it

Will integrate doc gen into CI after we finish writing the first version of the docs

@mjdemedeiros
Copy link
Collaborator Author

The command lake -R -Kenv=doc build SampCert:docs will build the documentation (it takes a minute) which you can view at .lake/build/doc/index.html (as per the doc-view4 instructions, to see them locally you should use a local webserver in that directory).

I will wait until I understand the CI story to point leanprover.github.io/SampCert/ to a hosted version of these, like Mathlib they should (probably) not be hosted in this repository.

@mjdemedeiros mjdemedeiros marked this pull request as ready for review May 22, 2024 21:34
@jtristan jtristan merged commit 414fabe into leanprover:main May 22, 2024
2 checks passed
@mjdemedeiros mjdemedeiros deleted the doc-gen branch May 23, 2024 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
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
@mjdemedeiros @jtristan