Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: bazelbuild/rules_rust
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: main
Choose a base ref
...
head repository: ticketmaster/rules_rust
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: main
Choose a head ref
Able to merge. These branches can be automatically merged.
  • 1 commit
  • 1 file changed
  • 1 contributor

Commits on Mar 20, 2025

  1. rustdoc: make html_in_header work 

    Signed-off-by: Greg Bowyer <[email protected]>
    @GregBowyer
    GregBowyer committed Mar 20, 2025
    Loading
    Loading status checks…
    Copy the full SHA
    31747b7 View commit details
Showing with 30 additions and 1 deletion.
  1. +30 −1 rust/private/rustdoc.bzl
31 changes: 30 additions & 1 deletion rust/private/rustdoc.bzl
View file
Original file line number Diff line number Diff line change
@@ -84,6 +84,17 @@ def rustdoc_compile_action(
rustdoc_flags = rustdoc_flags + lints_info.rustdoc_lint_flags
lint_files = lint_files + lints_info.rustdoc_lint_files

# Collect HTML customization files
html_input_files = []
if hasattr(ctx.file, "html_in_header") and ctx.file.html_in_header:
html_input_files.append(ctx.file.html_in_header)
if hasattr(ctx.file, "html_before_content") and ctx.file.html_before_content:
html_input_files.append(ctx.file.html_before_content)
if hasattr(ctx.file, "html_after_content") and ctx.file.html_after_content:
html_input_files.append(ctx.file.html_after_content)
if hasattr(ctx.files, "markdown_css"):
html_input_files.extend(ctx.files.markdown_css)

cc_toolchain, feature_configuration = find_cc_toolchain(ctx)

dep_info, build_info, _ = collect_deps(
@@ -149,9 +160,12 @@ def rustdoc_compile_action(
if "OUT_DIR" in env:
env.update({"OUT_DIR": "${{pwd}}/{}".format(build_info.out_dir.short_path)})

# Create the combined inputs including HTML customization files
all_inputs = depset([crate_info.output], transitive = [compile_inputs, depset(html_input_files)])

return struct(
executable = ctx.executable._process_wrapper,
inputs = depset([crate_info.output], transitive = [compile_inputs]),
inputs = all_inputs,
env = env,
arguments = args.all,
tools = [toolchain.rust_doc],
@@ -205,6 +219,21 @@ def _rust_doc_impl(ctx):
"--extern",
"{}={}".format(crate_info.name, crate_info.output.path),
]

# Add HTML customization flags if attributes are provided
if ctx.attr.html_in_header:
rustdoc_flags.extend(["--html-in-header", ctx.file.html_in_header.path])

if ctx.attr.html_before_content:
rustdoc_flags.extend(["--html-before-content", ctx.file.html_before_content.path])

if ctx.attr.html_after_content:
rustdoc_flags.extend(["--html-after-content", ctx.file.html_after_content.path])

# Add markdown CSS files if provided
for css_file in ctx.files.markdown_css:
rustdoc_flags.extend(["--markdown-css", css_file.path])

rustdoc_flags.extend(ctx.attr.rustdoc_flags)

action = rustdoc_compile_action(