rustdoc: List of issues related to Markdown input files
Open
Nobody has claimed this yet.
C-bug
T-rustdoc
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
I didn't feel like opening 3 2 GH issues for these niche issues, so here's a single one.
-
Given a Markdown input file and--markdown-css file.css, the depinfo (--emit=depinfo -Zunstable-options) doesn't listfile.css - Given a Markdown input file and
--markdown-css file.css, the generated HTML document contains<link rel="stylesheet" href="file.css">but that path won't resolve unless you set-o./--output-dir=.since it doesn't properly account for the output directory (which isdoc/by default) - Given a Markdown input file and
--emit=html-static-filesor--emit=dep-infoor--emit=html-static-files,dep-info, we still emit a non-static HTML file, e.g,doc/file.html(which should only be emitted if--emitcontainshtml-non-static-fileswhich it implicitly does by default)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the remaining rustdoc Markdown-input cases with --markdown-css file.css and the listed --emit options, using the default doc/ output directory. Trace rustdoc's depinfo, stylesheet-link, and static-file emission paths; done means file.css is tracked, the stylesheet link resolves from doc/, and non-static HTML is not emitted for static-only requests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100