-
Notifications
You must be signed in to change notification settings - Fork 170
feat: use docgen-action for documentation generation #128
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
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
078c52a
feat: use docgen-action for documentation generation
jessealama a66e6f7
fix: address PR feedback on docs workflow
jessealama 15d2f94
Add build-page: false option to docgen-action
jessealama 9e3137b
remove the check for matching docs toolchain
chenson2018 ee76019
move references.bib root directory
chenson2018 898f144
remove docs directory
chenson2018 973fabc
merge conflict
chenson2018 c9433eb
move references into docbuild directory
chenson2018 b857df9
move references.bib to root
chenson2018 4dd80a9
Merge remote-tracking branch 'upstream/main' into use-docgen-action
chenson2018 649716b
merge conflict
chenson2018 e65f34c
merge conflict.. again
chenson2018 095bf99
correct toolchain
chenson2018 b8e32a0
merge again
chenson2018 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| name: Build and Deploy Documentation | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main # Build docs on merges to main | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| id-token: write | ||
| pages: write | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout project | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Build and lint the project | ||
| id: build-lean | ||
| uses: leanprover/lean-action@v1 | ||
| with: | ||
| build-args: "--wfail" | ||
|
|
||
| - name: Build project documentation | ||
| id: build-docgen | ||
| uses: leanprover-community/docgen-action@main | ||
| with: | ||
| build-page: false | ||
This file contains hidden or 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
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
File renamed without changes.
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.
Uh oh!
There was an error while loading. Please reload this page.