#docs #docset #rsdoc

bin+lib rsdocs2docset

This is a small tool to generate a docsets for Dash / Velocity / Zeal / LovelyDocs out of Rust docs

8 unstable releases (3 breaking)

Uses old Rust 2015

0.4.1 Jan 12, 2017
0.4.0 Jan 11, 2017
0.3.0 Jan 10, 2017
0.2.9 Jan 9, 2017
0.1.2 Jan 6, 2017

#270 in #docs

MIT license

53KB
1K SLoC

Build Status Build status

rsdocs2docset

This is a small tool to generate a docsets for Dash / Velocity / Zeal / LovelyDocs out of Rust docs.

installation

Simply call

cargo install rsdocs2docset

or download the latest version from the release page or clone this repo, make sure you have rust installed and execute

cargo install

usage

given your docs live in target/doc, execute

rsdocs2docset --rsdocs target/doc --name mycrate

and rsdocs2docset will create a folder called mycrate.docset ... or, given you have rustup and a nighlty rust version installed, use the included ./create-rs-docset script to create docs for a specific package that can be found using cargo:

./create-rs-docset html5ever

This can take long the first time, but it caches build artifacts in ~/.rs-docsets, so it should get faster over time. This is a stepping stone for now

Dependencies

~7–13MB
~176K SLoC