Skip to content

[dg] Add option to output html docs to file instead of tmpfile/browser #27632

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 2 commits into from
Feb 13, 2025

Conversation

benpankow
Copy link
Member

Summary

I selfishly want this functionality for e2e tests, but I also think users might find it helpful

@benpankow benpankow requested a review from OwenKephart February 6, 2025 21:56
Base automatically changed from benpankow/existing-code-location-test to master February 6, 2025 22:03
@benpankow benpankow requested a review from neverett as a code owner February 6, 2025 22:03
@benpankow benpankow force-pushed the benpankow/docs-cmd-option-to-output branch from 3fd60d4 to 8562905 Compare February 7, 2025 16:43
@benpankow benpankow force-pushed the benpankow/docs-cmd-option-to-output branch from 8562905 to 7c89080 Compare February 7, 2025 17:26
@benpankow benpankow force-pushed the benpankow/docs-cmd-option-to-output branch from 2ae1a99 to 101ddfb Compare February 7, 2025 18:44
@benpankow benpankow requested a review from smackesey February 10, 2025 15:51
@neverett neverett removed their request for review February 10, 2025 16:17
@benpankow benpankow requested a review from gibsondan February 10, 2025 18:58
Copy link
Collaborator

@smackesey smackesey left a comment

Choose a reason for hiding this comment

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

This is good but I want to quibble over the API/defaults. I would prefer:

  • by default just dump the output to terminal (current --output cli)
  • no --output option
  • --browser flag that opens browser

@schrockn what are your thoughts

@benpankow benpankow requested a review from schrockn February 10, 2025 20:37
@benpankow
Copy link
Member Author

  • by default just dump the output to terminal (current --output cli)

I think the in-browser docs is more useful for the average user than the raw html, so it feels a bit wrong to gate that behind an option. I guess if all docs present that option first maybe it's fine

Copy link
Member

I think it should default to browswer

@benpankow benpankow merged commit 256d395 into master Feb 13, 2025
6 checks passed
@benpankow benpankow deleted the benpankow/docs-cmd-option-to-output branch February 13, 2025 16:37
braunjj pushed a commit that referenced this pull request Feb 14, 2025
#27632)

## Summary

I selfishly want this functionality for e2e tests, but I also think
users might find it helpful
brentjericho pushed a commit to brentjericho/dagster that referenced this pull request Feb 21, 2025
dagster-io#27632)

## Summary

I selfishly want this functionality for e2e tests, but I also think
users might find it helpful
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.

3 participants