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

Add scarb-doc-generated corelib docs to GitHub Pages #1658

Merged
merged 14 commits into from
Oct 24, 2024
Merged

Add scarb-doc-generated corelib docs to GitHub Pages #1658

merged 14 commits into from
Oct 24, 2024

Conversation

DelevoXDG
Copy link
Contributor

@DelevoXDG DelevoXDG commented Oct 18, 2024 •
edited
Loading

@DelevoXDG DelevoXDG force-pushed the zdobnikau/deploy-corelib-gh-pages branch from 4b792db to 32d4f8e Compare October 18, 2024 16:42
@DelevoXDG DelevoXDG force-pushed the zdobnikau/deploy-corelib-gh-pages branch from 61d991d to 5dde14d Compare October 18, 2024 17:45
@DelevoXDG DelevoXDG changed the title Update website deployment workflow to include corelib docs Add scarb-doc-generated corelib docs to GitHub Pages Oct 18, 2024
@DelevoXDG DelevoXDG marked this pull request as ready for review October 18, 2024 18:30
@piotmag769
Copy link
Contributor

No structs seem to have a signature in ur demo link. @wawel37 is that a scarb-doc bug?

@wawel37
Copy link
Member

wawel37 commented Oct 21, 2024 •
edited
Loading

No structs seem to have a signature in ur demo link. @wawel37 is that a scarb-doc bug?

Hmmm, strange. @DelevoXDG , what version of scarb is used by default with uses: software-mansion/setup-scarb@v1? It's either because of some older version of scarb which doesn't have the struct signatures implemented yet, or just a bug in scarb-doc. It's strange because as I'm testing it right now (scarb main branch build), everything work just fine

@DelevoXDG DelevoXDG requested a review from maciektr October 22, 2024 08:57
maciektr
maciektr reviewed Oct 22, 2024
View reviewed changes
Copy link
Contributor

@maciektr maciektr left a comment •
edited
Loading

Choose a reason for hiding this comment

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

👍
Two minor comments attached below.

@DelevoXDG
Extract corelib path from scarb metadata
6385cdc 
Instead of extracting cairo version / commit hash
@DelevoXDG DelevoXDG requested a review from maciektr October 23, 2024 23:20
@DelevoXDG DelevoXDG force-pushed the zdobnikau/deploy-corelib-gh-pages branch 2 times, most recently from 396c086 to 6385cdc Compare October 24, 2024 00:35
@maciektr maciektr enabled auto-merge October 24, 2024 09:35
@maciektr maciektr added this pull request to the merge queue Oct 24, 2024
Merged via the queue into software-mansion:main with commit dd11e16 Oct 24, 2024
22 checks passed
DelevoXDG added a commit that referenced this pull request Nov 19, 2024
@DelevoXDG @maciektr
Add scarb-doc-generated corelib docs to GitHub Pages (#1658)
1a384fd 
Closes #1381

Preview: 
- https://delevoxdg.github.io/scarb/corelib/index.html
- https://delevoxdg.github.io/scarb/docs

---------

Signed-off-by: maciektr <[email protected]>
Co-authored-by: maciektr <[email protected]>
@BrewTestBot BrewTestBot mentioned this pull request Nov 30, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maciektr maciektr maciektr approved these changes

@wawel37 wawel37 wawel37 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Automatic docs generation for corelib
4 participants
@DelevoXDG @piotmag769 @wawel37 @maciektr