Skip to content

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

Closed
@brson

Description

@brson
Contributor

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.

Activity

ghost assigned on May 21, 2013
metajack

metajack commented on May 23, 2013

@metajack
Contributor

nominating feature complete

graydon

graydon commented on Jun 20, 2013

@graydon
Contributor

sub-bug of #5413

pnkfelix

pnkfelix commented on Jun 27, 2013

@pnkfelix
Member

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

brson

brson commented on Jun 27, 2013

@brson
ContributorAuthor

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

thestinger

thestinger commented on Sep 2, 2013

@thestinger
Contributor

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

pnkfelix

pnkfelix commented on Jan 22, 2014

@pnkfelix
Member

Assigning P-low.

alexcrichton

alexcrichton commented on May 22, 2014

@alexcrichton
Member

Closing, this has been completed.

2 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    C-enhancementCategory: An issue proposing an enhancement or a PR with one.P-lowLow priorityT-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @graydon@metajack@alexcrichton@brson@pnkfelix

        Issue actions

          Combine rustdoc, prep.js and extract-tests.js · Issue #3546 · rust-lang/rust