Skip to content

Teach rustdoc to syntax highlight #11393

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

Jump to bottom
Closed
brson opened this issue Jan 8, 2014 · 1 comment · Fixed by #12416
Closed

Teach rustdoc to syntax highlight #11393

brson opened this issue Jan 8, 2014 · 1 comment · Fixed by #12416
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@brson
Copy link
Contributor

brson commented Jan 8, 2014

We can probably port the js code from doc/lib to Rust. It's really small.
@brson brson mentioned this issue Jan 8, 2014
Closed
@thehydroimpulse
Copy link
Contributor

@brson For syntax highlighting, we could pipe the code snippets to pygments while generating the docs, or we could do the highlighting on the client with something like highlight.js. The former option seems better, and is what I'm currently using for prototyping.

@alexcrichton alexcrichton mentioned this issue Feb 20, 2014
Merged
bors added a commit that referenced this issue Feb 23, 2014
@bors
auto merge of #12416 : alexcrichton/rust/highlight, r=huonw
8786405 
This adds simple syntax highlighting based off libsyntax's lexer to be sure to
stay up to date with rust's grammar. Some of the highlighting is a bit ad-hoc,
but it definitely seems to get the job done!

This currently doesn't highlight rustdoc-rendered function signatures and
structs that are emitted to each page because the colors already signify what's
clickable and I think we'd have to figure out a different scheme before
colorizing them. This does, however, colorize all code examples and source code.

Closes #11393
flip1995 pushed a commit to flip1995/rust that referenced this issue Sep 7, 2023
@c410-f3r
[arithmetic_side_effects] Fix rust-lang#11393
2faa43c
flip1995 pushed a commit to flip1995/rust that referenced this issue Sep 7, 2023
@bors
Auto merge of rust-lang#11395 - c410-f3r:let-chain, r=Manishearth
706c48b 
[`arithmetic_side_effects`] Fix rust-lang#11393

Fix rust-lang#11393

```
changelog: [`arithmetic_side_effects`]: Detect division by zero for `Wrapping` and `Saturating`
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

rustdoc: Add syntax highlighting alexcrichton/rust
3 participants
@steveklabnik @brson @thehydroimpulse