EnglishFrenchSpanish

OnWorks favicon

rustdoc - Online in the Cloud

Run rustdoc in OnWorks free hosting provider over Ubuntu Online, Fedora Online, Windows online emulator or MAC OS online emulator

This is the command rustdoc that can be run in the OnWorks free hosting provider using one of our multiple free online workstations such as Ubuntu Online, Fedora Online, Windows online emulator or MAC OS online emulator

PROGRAM:

NAME


rustdoc - generate documentation from Rust source code

SYNOPSIS


rustdoc [OPTIONS] INPUT

DESCRIPTION


This tool generates API reference documentation by extracting comments from source code
written in the Rust language, available at ⟨https://www.rust-lang.org⟩. It accepts
several input formats and provides several output formats for the generated documentation.

OPTIONS


-r, --input-format FORMAT
html or json (default: inferred)

-w, --output-format FORMAT
html or json (default: html)

-o, --output OUTPUT
where to place the output (default: doc/ for html, doc.json for json)

--passes LIST
space‐separated list of passes to run (default: '')

--no-defaults
don't run the default passes

--plugins LIST
space-separated list of plugins to run (default: '')

--plugin-path DIR
directory to load plugins from (default: /tmp/rustdoc_ng/plugins)

--target TRIPLE
target triple to document

--crate-name NAME
specify the name of this crate

-L, --library-path DIR
directory to add to crate search path

--cfg SPEC
pass a --cfg to rustc

--extern VAL
pass an --extern to rustc

--test run code examples as tests

--test-args ARGS
pass arguments to the test runner

--html-in-header FILE
file to add to <head>

--html-before-content FILE
file to add in <body>, before content

--html-after-content FILE
file to add in <body>, after content

--markdown-css FILE
CSS files to include via <link> in a rendered Markdown file

--markdown-playground-url URL
URL to send code snippets to

--markdown-no-toc
don't include table of contents

-h, --help
Print help

-V, --version
Print rustdoc's version

OUTPUT FORMATS


The rustdoc tool can generate output in either an HTML or JSON format.

If using an HTML format, then the specified output destination will be the root directory
of an HTML structure for all the documentation. Pages will be placed into this directory,
and source files will also possibly be rendered into it as well.

If using a JSON format, then the specified output destination will have the rustdoc output
serialized as JSON into it. This output format exists to pre‐compile documentation for
crates, and for usage in non‐rustdoc tools. The JSON output is the following hash:

{
"schema": VERSION,
"crate": ...,
"plugins": ...,
}

The schema version indicates what the structure of crate/plugins will look like. Within a
schema version the structure will remain the same. The crate field will contain all
relevant documentation for the source being documented, and the plugins field will contain
the output of the plugins run over the crate.

EXAMPLES


To generate documentation for the source in the current directory:
$ rustdoc hello.rs

List all available passes that rustdoc has, along with default passes:
$ rustdoc --passes list

To precompile the documentation for a crate, and then use it to render html at a later
date:
$ rustdoc -w json hello.rs
$ rustdoc doc.json

The generated HTML can be viewed with any standard web browser.

Use rustdoc online using onworks.net services


Free Servers & Workstations

Download Windows & Linux apps

  • 1
    Phaser
    Phaser
    Phaser is a fast, free, and fun open
    source HTML5 game framework that offers
    WebGL and Canvas rendering across
    desktop and mobile web browsers. Games
    can be co...
    Download Phaser
  • 2
    VASSAL Engine
    VASSAL Engine
    VASSAL is a game engine for creating
    electronic versions of traditional board
    and card games. It provides support for
    game piece rendering and interaction,
    and...
    Download VASSAL Engine
  • 3
    OpenPDF - Fork of iText
    OpenPDF - Fork of iText
    OpenPDF is a Java library for creating
    and editing PDF files with a LGPL and
    MPL open source license. OpenPDF is the
    LGPL/MPL open source successor of iText,
    a...
    Download OpenPDF - Fork of iText
  • 4
    SAGA GIS
    SAGA GIS
    SAGA - System for Automated
    Geoscientific Analyses - is a Geographic
    Information System (GIS) software with
    immense capabilities for geodata
    processing and ana...
    Download SAGA GIS
  • 5
    Toolbox for Java/JTOpen
    Toolbox for Java/JTOpen
    The IBM Toolbox for Java / JTOpen is a
    library of Java classes supporting the
    client/server and internet programming
    models to a system running OS/400,
    i5/OS, o...
    Download Toolbox for Java/JTOpen
  • 6
    D3.js
    D3.js
    D3.js (or D3 for Data-Driven Documents)
    is a JavaScript library that allows you
    to produce dynamic, interactive data
    visualizations in web browsers. With D3
    you...
    Download D3.js
  • More »

Linux commands

Ad