Skip to content

Add --open flag to scarb doc command#2948

Merged
maciektr merged 1 commit intomainfrom
maciektr/docs-build-open
Jan 14, 2026
Merged

Add --open flag to scarb doc command#2948
maciektr merged 1 commit intomainfrom
maciektr/docs-build-open

Conversation

@maciektr
Copy link
Contributor

This commit adds a new flag to the command.
When provided, this flag enforces documentation building (equivalent to ) and then attempts to open the generated documentation in the default browser using the crate.

  • Added crate dependency.
  • Updated struct in to include flag.
  • Updated to handle flag and open the index.html file.
  • Added integration test for the new flag.

@maciektr maciektr requested a review from a team as a code owner January 13, 2026 18:04
This commit adds a new  flag to the  command.
When provided, this flag enforces documentation building (equivalent to )
and then attempts to open the generated documentation in the default browser
using the  crate.

- Added  crate dependency.
- Updated  struct in  to include  flag.
- Updated  to handle  flag and open the index.html file.
- Added integration test for the new flag.
@maciektr maciektr force-pushed the maciektr/docs-build-open branch from 454a701 to f00aa70 Compare January 13, 2026 18:05
Copy link
Contributor

@FroyaTheHen FroyaTheHen left a comment

Choose a reason for hiding this comment

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

Nice 👌 I like that feature ^^ out of curiosity did somebody ask or was it solely you idea??

@maciektr
Copy link
Contributor Author

@FroyaTheHen No one asked afaik, just realized it's handy while manually testing changes in doc :)

@maciektr maciektr added this pull request to the merge queue Jan 14, 2026
Merged via the queue into main with commit 15f5bfd Jan 14, 2026
16 checks passed
@maciektr maciektr deleted the maciektr/docs-build-open branch January 14, 2026 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants