Accéder au contenu principal Passer au contenu complémentaire

Générer la documentation HTML

Le Studio Talend vous permet de générer de la documentation détaillée au format HTML pour les Jobs ou Routes sélectionné·es dans la vue Repository de votre Studio Talend, dans la perspective Integration. Cette auto-documentation comprend :

  • les propriétés du projet dans lequel les Jobs ou les Routes ont été créé·es,

  • les propriétés et les paramètres des Jobs ou des Routes sélectionné·es ainsi qu'une image de chaque Job ou Route,

  • la liste de tous les composants utilisés dans chaque Job ou Route sélectionné·e, ainsi que les paramètres de ces composants.

  • Si votre Job ou Route contient des Joblets, Routelets ou des Jobs enfants, lorsque vous générez la documentation du Job ou de la Route, la documentation de ses Joblets, Routelets, ou de ses Jobs enfants est également générée. Vous pouvez naviguer vers la documentation du Joblet, Routelet, ou du Job enfant via le lien correspondant dans la documentation du Job ou de la Route.

Pour générer un document HTML pour un Job ou une Route, procédez comme suit :

Procédure

  1. Dans le Repository, cliquez-droit sur l'un·e de vos Jobs ou Routes ou sélectionnez plusieurs éléments pour générer une documentation multiple.
  2. Sélectionnez Generate Doc as HTML dans le menu contextuel.
    Boîte de dialogue Generate Documentation (Générer la documentation).
  3. Renseignez le répertoire dans lequel doit être enregistré la documentation générée.
  4. Dans le même champ, renseignez le nom de l'archive regroupant les documents générés.
  5. Si vous souhaitez utiliser un fichier CSS, cochez la case Use CSS file as a template to export afin d'activer le champ CSS File.
  6. Dans le champ CSS File, parcourez votre répertoire, ou saisissez le chemin d'accès au fichier CSS à utiliser.
  7. Cliquez sur Finish pour valider.

Résultats

Le fichier archive contient les fichiers HTML ainsi que les dossiers correspondants. Il contient tous les fichiers requis, ainsi que le fichier HTML de sortie. Ouvrez le fichier HTML dans votre navigateur Web.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici