rust-lang / rust-lang/cargo

cargo-doc: enable using --html-in-header and other rustdoc flags

Open
#331 25 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-configuration Command-doc S-needs-design
Dominant language
Rust
Stars
15.5k
Forks
3k
Avg merge
23h 30m
Merged PRs (30d)
51

Description

Currently I see no way of doing this. Perhaps it should be Cargo.toml configuration keys?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining the cargo-doc behavior and the existing Cargo.toml configuration options. Determine how rustdoc flags such as --html-in-header should be represented and passed through, then define tests that verify the configuration and resulting rustdoc invocation.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.