Browse Source

Une option --force sur l'aide à la génération des docs de plugin, pour générer la doc même si le plugin n'a pas été mis à jour.

svn/root/trunk
marcimat@rezo.net 7 years ago
parent
commit
380c51b8ec
  1. 11
      installation.md
  2. 1
      src/autodoc/Helpers/Command/FromFile.php
  3. 5
      src/autodoc/Helpers/Generator.php

11
installation.md

@ -205,4 +205,15 @@ Par défaut, utilise le fichier svn de la zone.
autodoc/bin/autodoc_helper from:file autodoc.txt
autodoc/bin/autodoc_helper from:file svn://zone.spip.org/spip-zone/autodoc.txt
Les documentations sont générées chacunes dans leur répertoire nommée par le préfixe du plugin
et un sommaire est généré dans le répertoire de sortie (work/output par défaut) et les plugins
générés sont dans work/output/$prefixe.
Si le plugin n'a pas eu de commit depuis la dernière génération, la documentation
n'est pas recrée.
On peut forcer :
- le répertoire de sortie : `--sorties=chemin`
- le plugin généré (via son préfixe) : `--prefixe=saisies`
- ou forcer la génération de la documentation, même si ce n'est pas nécessaire : `--force`

1
src/autodoc/Helpers/Command/FromFile.php

@ -38,6 +38,7 @@ svn://zone.spip.org/spip-zone/_plugins_/champs_extras/core/trunk;cextras
->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS à charger dans le head html. <comment>Exemple : '//boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
->addOption('prefixe', 'p', InputOption::VALUE_OPTIONAL, "Préfixe de plugin. Lui seul sera actualisé si présent.")
->addOption('force', '', InputOption::VALUE_NONE, "Force la génération de la documentation même si le plugin n'a eu de modifications depuis la fois précédente.")
;
}

5
src/autodoc/Helpers/Generator.php

@ -287,7 +287,10 @@ class Generator
$revision_nouvelle = $this->recuperer_revision_svn();
if ($revision_nouvelle <= $revision_actuelle) {
$this->output->writeln("* Documentation déjà à jour.");
return null;
// sauf si on le force explicitement
if (!$this->getOption('force')) {
return null;
}
}
$ok = $this->prepareConfigXml() && $this->clearLogs();

Loading…
Cancel
Save