Génère des documents

L'usage secondaire de configlet est la génération de documents.

Utilisation

La commande generate permet de générer des documents instructions/introductions à partir d'un modèle.

configlet [global-options] generate

Global options:
  -h, --help                   Show this help message and exit
      --version                Show this tool's version information and exit
  -t, --track-dir <dir>        Specify a track directory to use instead of the current directory
  -v, --verbosity <verbosity>  The verbosity of output. Allowed values: q[uiet], n[ormal], d[etailed]

Documents

Voici les documents que configlet peut générer.

Document : le fichier introduction.md d'un exercice d'apprentissage

Chaque exercice d'apprentissage a un fichier introduction.md. Chaque exercice peut avoir un fichier introduction.md.tpl facultatif.

Le fichier modèle doit être traité comme un fichier Markdown ordinaire, à une exception près : la possibilité de définir des espaces réservés. Les espaces réservés suivants sont pris en charge :

• %{concept:<slug>} : fait référence au document introduction.md du concept

Quand configlet détecte qu'un exercice d'apprentissage possède un fichier introduction.md.tpl, il génère un fichier introduction.md à partir de celui-ci. L'introduction générée a le même contenu que le modèle, à l'exception des espaces réservés, qui sont remplacés par le contenu des documents auxquels ils font référence.

Document : le fichier introduction.md d'un exercice d'entraînement

Quand configlet détecte qu'un exercice d'entraînement implémente un exercice des Problem Specifications qui possède un fichier introduction.md, configlet synchronise le fichier .meta/introduction.md de l'exercice d'entraînement avec le fichier introduction.md de l'exercice des Problem Specifications.

Document : le fichier instructions.md d'un exercice d'entraînement

Quand configlet détecte qu'un exercice d'entraînement implémente un exercice des Problem Specifications, configlet synchronise le fichier .meta/instructions.md de l'exercice d'entraînement avec le fichier instructions.md de l'exercice des Problem Specifications, ou avec son fichier description.md quand aucun fichier instructions.md n'a été trouvé.

Document : le fichier .meta/config.json d'un exercice d'entraînement

Quand configlet détecte qu'un exercice d'entraînement implémente un exercice des Problem Specifications, configlet synchronise les clés source et source_url de l'exercice des Problem Specifications, présentes dans son fichier metadata.yml, vers les propriétés source et source_url de l'exercice d'entraînement dans son fichier .meta/config.json.