JScearcy / rust-doc-viewer

A VS Code extension to view generated rust docs in another VS Code tab

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

rust-doc-viewer

This extension will take your locally generated project docs and display them in a new window for easier reference.

Version 4.0.0 may break any documentation generated using older cargo-doc implementations - tested on 1.72.0 toolchain

Use

  • Create the documentation using cargo doc inside of your project folder
  • Open the folder in VS Code
  • Open the Command Palette Ctrl+Shift+P or Cmd+Shift+P
  • Search and activate Rust: Doc Viewer

Features

Open your rust docs and view them in another tab in VS Code

Rust Doc Viewer Demo

Known Issues

1.) No easy navigation

2.) Requires documentation to be in the standard output from `cargo docs` 

3.) Testing and build automation

About

A VS Code extension to view generated rust docs in another VS Code tab

License:MIT License


Languages

Language:TypeScript 81.9%Language:JavaScript 17.9%Language:CSS 0.2%