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

Jump to bottom

Combine rustdoc, prep.js and extract-tests.js #3546

Closed
brson opened this issue Sep 20, 2012 · 7 comments
Closed

Combine rustdoc, prep.js and extract-tests.js #3546

brson opened this issue Sep 20, 2012 · 7 comments
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. P-low Low priority T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@brson
Copy link
Contributor

brson commented Sep 20, 2012

rustdoc needs syntax highlighting and the ability to execute code examples, and it would be nice if all the documentation logic were inside rustdoc (there's a lot of boilerplate in tests.mk to support doc tests).

extract-tests.js we can rewrite in Rust using an integrated driver (instead of using compiletest as we currently do). The parts of prep.js that interpret the little directives embedded in examples can be rewritten in rust. For now, the syntax highlighting scripts can be include!ed in rustdoc and rustdoc can drive the python script. Ultimately, pandoc should handle the syntax highlighting.
@brson brson mentioned this issue Sep 23, 2012
Closed
@ghost ghost assigned z0w0 May 21, 2013
@metajack
Copy link
Contributor

nominating feature complete

@graydon
Copy link
Contributor

graydon commented Jun 20, 2013

sub-bug of #5413

@pnkfelix
Copy link
Member

extracting tests from api docs is important enough for milestone. accepted for milestone production ready.

@brson
Copy link
Contributor Author

brson commented Jun 27, 2013

Syntax highlighting is now provided by pandoc, so we don't need js for it.

@thestinger
Copy link
Contributor

This is still an issue. The pandoc on the doc builder needs to be updated.

alexcrichton added a commit to alexcrichton/rust that referenced this issue Sep 24, 2013
@alexcrichton
Use sundown for markdown highlighting in rustdoc
19ac447 
This takes rendering times of documentation down from 30s to 0.5s. Kinda sad
that none of the parallelism is needed, but oh well!

Closes rust-lang#7380
cc rust-lang#3546
alexcrichton added a commit to alexcrichton/rust that referenced this issue Sep 25, 2013
@alexcrichton
rustdoc: Use sundown for markdown highlighting
db28c29 
This takes rendering times of documentation down from 30s to 0.5s. Kinda sad
that none of the parallelism is needed, but oh well!

Closes rust-lang#7380
cc rust-lang#3546
@pnkfelix
Copy link
Member

Assigning P-low.

@alexcrichton
Copy link
Member

Closing, this has been completed.

@brson brson unassigned z0w0 Jun 16, 2014
bors pushed a commit to rust-lang-ci/rust that referenced this issue May 15, 2021
@scampi
Merge pull request rust-lang#3546 from bash/unreachable-pub
cc97eaf 
Enable unreachable_pub lint
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. P-low Low priority T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@graydon @metajack @alexcrichton @brson @pnkfelix @z0w0 @thestinger