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

[docs] add some margin and padding to api docs #27490

Merged
merged 3 commits into from
Feb 3, 2025
Merged

[docs] add some margin and padding to api docs #27490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ccc907a
[docs] add some margin and padding to api docs
cmpadden Feb 1, 2025
d1fcbcc
Remove padding from last p element
cmpadden Feb 2, 2025
a3f13db
ammend
cmpadden Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/docs-beta/src/styles/custom.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,8 @@ table {

/* API Docs */
dl {
padding: 4px 0px 0px 4px;
padding: 6px;
margin-top: 6px;
border: 1px solid var(--theme-color-keyline);
font-weight: 200;
background-color: var(--theme-color-background-blue);
Expand All @@ -518,7 +519,10 @@ dd {
}

dd p {
margin: 0;
margin-bottom: 6px;
&:last-child {
margin-bottom: 0px;
}
}

dd code {
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/_ext/dagster-sphinx/dagster_sphinx/docstring_flags.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def inject_object_flag(
elif isinstance(info, SupersededInfo):
additional_text = f" {info.additional_warn_text}." if info.additional_warn_text else ""
flag_type = "superseded"
message = f"This API has been superseded and its usage is discouraged.\n{additional_text}"
message = f"This API has been superseded.\n{additional_text}"
elif isinstance(info, PreviewInfo):
additional_text = f" {info.additional_warn_text}." if info.additional_warn_text else ""
flag_type = "preview"
Expand Down
2 changes: 1 addition & 1 deletion python_modules/dagster/dagster/_core/definitions/step_launcher.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def __new__(

_step_launcher_supersession = superseded(
subject="StepLauncher",
additional_warn_text="This API has been superseded, but there is no plan to remove this functionality. For new projects, we recommend using Dagster Pipes. For more information, see https://docs.dagster.io/guides/build/external-pipelines/",
additional_warn_text="While there is no plan to remove this functionality, for new projects, we recommend using Dagster Pipes. For more information, see https://docs.dagster.io/guides/build/external-pipelines/",
)


Expand Down