rustdoc - En ligne dans le Cloud

PROGRAMME:

Nom

rustdoc - générer de la documentation à partir du code source de Rust

SYNOPSIS

rouilledoc [OPTIONS] CONTRIBUTION

DESCRIPTION

Cet outil génère une documentation de référence sur l'API en extrayant les commentaires du code source
écrit en langage Rust, disponible sur ⟨https://www.rust-lang.org⟩. il accepte
plusieurs formats d'entrée et fournit plusieurs formats de sortie pour la documentation générée.

OPTIONS

-r, --format-d'entrée Format
html ou json (par défaut : inféré)

-w, --format de sortie Format
html ou json (par défaut : html)

-o, --output SORTIE
où placer la sortie (par défaut : doc/ pour le html, doc.json pour json)

--passe LISTE
liste séparée par des espaces des passes à exécuter (par défaut : '')

--pas de valeurs par défaut
ne pas exécuter les passes par défaut

--plugins LISTE
liste séparée par des espaces des plugins à exécuter (par défaut : '')

--plugin-chemin DIR
répertoire à partir duquel charger les plugins (par défaut : /tmp/rustdoc_ng/plugins)

--cible TRIPLE
triple cible à documenter

--crate-nom Nom
précisez le nom de cette caisse

-L, --chemin-bibliothèque DIR
répertoire à ajouter au chemin de recherche de caisse

--cfg SPEC
passer un --cfg rouiller

--externe VAL
passer un --externe rouiller

--test exécuter des exemples de code en tant que tests

--test-arguments ARGS
passer des arguments au lanceur de test

--html-en-tête DOSSIER
fichier à ajouter

--html-avant-contenu DOSSIER
fichier à ajouter , avant le contenu

--html-après-contenu DOSSIER
fichier à ajouter , après contenu

--markdown-css DOSSIER
Fichiers CSS à inclure via dans un fichier Markdown rendu

--markdown-aire de jeux-url URL
URL vers laquelle envoyer des extraits de code

--markdown-no-toc
ne pas inclure la table des matières

-h, --Aidez-moi
Imprimer l'aide

-V, --version
Imprimer la version de rustdoc

SORTIE FORMATS

L'outil rustdoc peut générer une sortie au format HTML ou JSON.

Si vous utilisez un format HTML, la destination de sortie spécifiée sera le répertoire racine
d'une structure HTML pour toute la documentation. Les pages seront placées dans ce répertoire,
et les fichiers sources y seront également éventuellement rendus.

Si vous utilisez un format JSON, la destination de sortie spécifiée aura la sortie rustdoc
sérialisé en JSON dedans. Ce format de sortie existe pour pré-compiler la documentation pour
caisses, et pour une utilisation dans des outils non-rustdoc. La sortie JSON est le hachage suivant :

{
"schéma": VERSION,
"Caisse": ...,
"plugins": ...,
}

La version du schéma indique à quoi ressemblera la structure de crate/plugins. Dans un
version du schéma, la structure restera la même. Les caisse le champ contiendra tous
la documentation pertinente pour la source documentée, et le plugins le champ contiendra
la sortie des plugins s'exécute sur la caisse.

EXEMPLES

Pour générer de la documentation pour la source dans le répertoire courant :
$ rustdoc bonjour.rs

Répertoriez toutes les passes disponibles de rustdoc, ainsi que les passes par défaut :
$ rustdoc --liste des passes

Pour précompiler la documentation d'un crate, puis l'utiliser pour restituer le html ultérieurement
dates:
$ rouilledoc -w json hello.rs
$ rustdoc doc.json

Le code HTML généré peut être visualisé avec n'importe quel navigateur Web standard.

Utilisez rustdoc en ligne en utilisant les services onworks.net