Il s'agit de la commande openstack-doc-test qui peut être exécutée dans le fournisseur d'hébergement gratuit OnWorks en utilisant l'un de nos multiples postes de travail en ligne gratuits tels que Ubuntu Online, Fedora Online, l'émulateur en ligne Windows ou l'émulateur en ligne MAC OS
PROGRAMME:
Nom
openstack-doc-test - Outils de documentation OpenStack
PILE OUVERTE la VALIDATION OUTIL
SYNOPSIS
openstack-doc-test [options]
DESCRIPTION
openstack-doc-test permet de tester la validité du contenu de la documentation OpenStack.
OPTIONS
Général Options
--api-site
Gestion spéciale du site api et d'autres référentiels d'API pour gérer WADL.
--build-file-exception BUILD_FILE_EXCEPTION
Fichier qui sera ignoré lors des vérifications de suppression et de construction à générer
dépendances. Cela doit être fait pour les fichiers XML non valides uniquement.
--check-build
Essayez de créer des livres en utilisant des fichiers modifiés.
--check-suppressions
Vérifiez que les fichiers supprimés ne sont pas utilisés.
--vérifier les liens
Vérifiez que les URL liées sont valides et accessibles.
--vérifier la gentillesse
Vérifiez la gentillesse des fichiers, par exemple les espaces blancs.
--check-syntaxe
Vérifiez la syntaxe des fichiers modifiés.
--vérifie tout
Exécutez toutes les vérifications (par défaut si aucun argument n'est fourni).
--config-fichier PATH
Chemin d'accès à un fichier de configuration à utiliser. Plusieurs fichiers de configuration peuvent être spécifiés, avec
les valeurs dans les fichiers ultérieurs ont priorité.
--déboguer
Activez le code de débogage.
--file-exception FILE_EXCEPTION
Fichier qui sera ignoré lors de la validation de la gentillesse et de la syntaxe.
--Obliger
Forcez la validation de tous les fichiers et construisez tous les livres.
-h, --Aidez-moi
Afficher le message d'aide et quitter.
--ignore-répertoire IGNORE_DIR
Répertoire à ignorer pour la création de manuels. Le paramètre peut être passé
plusieurs fois pour ajouter plusieurs répertoires.
--Langue LANGUE, -l LANGUAGE
Construire un manuel traduit pour la langue dans path generate/$LANGUAGE .
--seulement-réserver LIVRE_SEULEMENT
Construisez chaque manuel spécifié.
--parallèle
Construire des livres en parallèle (par défaut).
--print-fichiers-inutilisés
Imprimer la liste des fichiers qui ne sont inclus nulle part dans le cadre du check-build.
--publier
Configurer le contenu dans le répertoire publish-docs pour la publication sur un site Web externe.
--verbeux
Exécution verbeuse.
--version
Numéro de version de sortie.
DES DOSSIERS
Lit le fichier doc-test.conf dans le répertoire de niveau supérieur du référentiel git pour l'option
traitement.
La construction de livres sera générée dans le répertoire de niveau supérieur du référentiel git :
· un annuaire publier-docs avec une copie des résultats de la construction.
· pour chaque livre construit un fichier journal nommé build-${book}.log.gz.
VOIR AUSSI
· Pile ouverte Documentation
Bugs
· openstack-doc-tools est hébergé sur Launchpad afin que vous puissiez voir les bogues actuels sur Bugs :
openstack-manuels
Utilisez openstack-doc-test en ligne à l'aide des services onworks.net
