spip-galaxie/code.spip.net_autodoc
Par Matthieu Marcillaud, le 28 novembre 2021 à 18h43min :
Mise à jour vers PhpDocumentor v3
Une bonne partie de l’application Autodoc disparait pour plusieurs raisons :
- On cherche à simplifier la maintenance de cette doc en ne créant pas de thème personnalisé,
car effectivement, la syntaxe PHP évolue bien plus vite que le temps disponible
pour adapter les templates aux évolutions. On préfère user juste d’un peu de
cosmétique avec un peu de CSS. Le thème complet d’avant disparait. - L’application est devenue un .phar et les surcharges sont improbables là où le code
d’origine ne l’a pas explicitement prévu. Je n’ai absolument pas l’énergie
de me replonger à gérer des passes de compilation comme avant pour retrouver
les balises ou pipelines dans le code (je ne sais même pas si c’est faisable sur cette version).
Cette partie disparait aussi. - On bascule sur du PHP 8.0 minimum.
On s’appuie sur différentes librairies dont toujours symfony/console, mais aussi
symfony/filesystem et League/Pipeline.
On gère les téléchargements et mises à jour Git avec l’outil checkout
(qui est donc nécessaire). Le fichier phpDocumentor.phar est aussi nécessaire
dans le répertoire de travail, tout comme la création d’un répertoire var
écrivable.
Une décoration spécifique du thème par défaut (css, svg), est copiée
dans la config générée (var/config/templates), et est alors utilisée
par phpDocumentor (sur le même principe de surcharge que les squelettes SPIP)
Les commandes from:directory, from:git, from:plugin, from:spip sont adaptées.
La commande from:file (lecture d’un fichier archivelist.txt) reste à faire.
Ajouté
README.md
placeholders/phpdoc.xml
src/Application.php
src/Checkout.php
src/Command/FromDirectory.php
src/Command/FromGit.php
src/Command/FromPlugin.php
src/Command/FromSpip.php
src/Command/FromZone.php
src/Context.php
src/Exception/AutodocException.php
src/Exception/ContextException.php
src/Generator.php
src/Git.php
src/Loader/AbstractLoader.php
src/Loader/Collection.php
src/Loader/LoaderInterface.php
src/Package.php
src/Stage/CheckStage.php
src/Stage/GitSpipStage.php
src/Stage/GitStage.php
src/Stage/PackageStage.php
src/Stage/PhpDocumentorConfigStage.php
src/Stage/PhpDocumentorStage.php
src/Stage/StageInterface.php
templates/template/css/custom.css.twig
templates/template/css/variables.css.twig
templates/template/icons/constant.svg.twig
templates/template/icons/method.svg.twig
Supprimé
.gitattributes
bin/autodoc_helper
installation.md
src/autodoc/Application.php
src/autodoc/Configuration.php
src/autodoc/Configuration/Option.php
src/autodoc/Configuration/Options.php
src/autodoc/Helpers/Application.php
src/autodoc/Helpers/Command/FromDirectory.php
src/autodoc/Helpers/Command/FromGit.php
src/autodoc/Helpers/Command/FromPlugin.php
src/autodoc/Helpers/Command/FromSpip.php
src/autodoc/Helpers/Command/FromSvn.php
src/autodoc/Helpers/Command/FromZone.php
src/autodoc/Helpers/phpdoc_helper.xml
src/autodoc/Plugin/Core/Compiler/Pass/ApisCollector.php
src/autodoc/Plugin/Core/Compiler/Pass/DirectoryTreeBuilder.php
src/autodoc/Plugin/Core/Compiler/Pass/ErrorsCollector.php
src/autodoc/Plugin/Core/Compiler/Pass/ExampleTagCorrector.php
src/autodoc/Plugin/Core/Compiler/Pass/GetTopNav.php
src/autodoc/Plugin/Core/Compiler/Pass/MarkersCollector.php
src/autodoc/Plugin/Core/Compiler/Pass/SpipShare.php
src/autodoc/Plugin/Core/Compiler/Pass/SpipTagsCollector.php
src/autodoc/Plugin/Core/Compiler/Pass/Statistics.php
src/autodoc/Plugin/Core/Compiler/Pass/UsedByTagBuilder.php
src/autodoc/Plugin/Core/Compiler/Pass/VcsInformations/Finder.php
src/autodoc/Plugin/Core/Compiler/Pass/VcsInformations/Git.php
src/autodoc/Plugin/Core/Compiler/Pass/VcsInformations/None.php
src/autodoc/Plugin/Core/Compiler/Pass/VcsInformations/Svn.php
src/autodoc/Plugin/Core/Compiler/Pass/VcsInformations/VcsInformationsAbstract.php
src/autodoc/Plugin/Core/Compiler/Pass/VcsLinkBuilder.php
src/autodoc/Plugin/Core/Compiler/Pass/VcsViewer/DefaultViewer.php
src/autodoc/Plugin/Core/Compiler/Pass/VcsViewer/Gitea.php
src/autodoc/Plugin/Core/Compiler/Pass/VcsViewer/Github.php
src/autodoc/Plugin/Core/Compiler/Pass/VcsViewer/Gitlab.php
src/autodoc/Plugin/Core/Compiler/Pass/VcsViewer/Redmine.php
src/autodoc/Plugin/Core/Compiler/Pass/VcsViewer/Trac.php
src/autodoc/Plugin/Core/Descriptor/ApiDescriptor.php
src/autodoc/Plugin/Core/Descriptor/DirectoryDescriptor.php
src/autodoc/Plugin/Core/Descriptor/Interfaces/DirectoryInterface.php
src/autodoc/Plugin/Core/Descriptor/PipelineDescriptor.php
src/autodoc/Plugin/Core/Descriptor/SpipTagDescriptor.php
src/autodoc/Plugin/Core/Descriptor/UsedByTagDescriptor.php
src/autodoc/Plugin/Core/Descriptor/Validator/ErrorCollector.php
src/autodoc/Plugin/Core/ServiceProvider.php
src/autodoc/Plugin/Core/Transformer/Router/UrlGenerator/Zora/ApiDescriptor.php
src/autodoc/Plugin/Core/Transformer/Router/UrlGenerator/Zora/ConstantDescriptor.php
src/autodoc/Plugin/Core/Transformer/Router/UrlGenerator/Zora/DirectoryDescriptor.php
src/autodoc/Plugin/Core/Transformer/Router/UrlGenerator/Zora/FileDescriptor.php
src/autodoc/Plugin/Core/Transformer/Router/UrlGenerator/Zora/FunctionDescriptor.php
src/autodoc/Plugin/Core/Transformer/Router/UrlGenerator/Zora/PackageDescriptor.php
src/autodoc/Plugin/Core/Transformer/Router/UrlGenerator/Zora/PipelineDescriptor.php
src/autodoc/Plugin/Core/Transformer/Router/UrlGenerator/Zora/ProjectDescriptor.php
src/autodoc/Plugin/Core/Transformer/Router/ZoraRouter.php
src/autodoc/Plugin/Core/Transformer/Writer/FileCleaner.php
src/autodoc/Plugin/Core/Transformer/Writer/FileConcat.php
src/autodoc/Plugin/Core/Transformer/Writer/Twig.php
src/autodoc/Plugin/Core/TwigZora.php
templates/zora/api.twig
templates/zora/apis.twig
templates/zora/balises.twig
templates/zora/body.twig
templates/zora/bootstrap/css/bootstrap.css
templates/zora/bootstrap/css/bootstrap.min.css
templates/zora/bootstrap/img/glyphicons-halflings-white.png
templates/zora/bootstrap/img/glyphicons-halflings.png
templates/zora/bootstrap/js/bootstrap.js
templates/zora/bootstrap/js/bootstrap.min.js
templates/zora/boucles.twig
templates/zora/breadcrumb/directory.twig
templates/zora/breadcrumb/package.twig
templates/zora/class.twig
templates/zora/classes.twig
templates/zora/constantes.twig
templates/zora/content/api.twig
templates/zora/content/apis.twig
templates/zora/content/balises.twig
templates/zora/content/boucles.twig
templates/zora/content/class.twig
templates/zora/content/classes.twig
templates/zora/content/constantes.twig
templates/zora/content/criteres.twig
templates/zora/content/deprecies.twig
templates/zora/content/directory.twig
templates/zora/content/dist.twig
templates/zora/content/erreurs.twig
templates/zora/content/file.twig
templates/zora/content/filtres.twig
templates/zora/content/marqueurs.twig
templates/zora/content/package.twig
templates/zora/content/packages.twig
templates/zora/content/pipeline.twig
templates/zora/content/pipelines.twig
templates/zora/content/recherche.twig
templates/zora/content/sommaire.twig
templates/zora/content/statistiques.twig
templates/zora/criteres.twig
templates/zora/css/perso.css
templates/zora/debug.twig
templates/zora/deprecies.twig
templates/zora/directory.twig
templates/zora/erreurs.twig
templates/zora/extra/dist.twig
templates/zora/favicon.png
templates/zora/file.twig
templates/zora/filtres.twig
templates/zora/footer/dist.twig
templates/zora/fqsen_data.twig
templates/zora/head-js/dist.twig
templates/zora/head/dist.twig
templates/zora/header/dist.twig
templates/zora/htaccess.twig
templates/zora/images/api-32.png
templates/zora/images/api-48.png
templates/zora/images/deprecated-48.png
templates/zora/images/loader-32.gif
templates/zora/images/logo.png
templates/zora/images/logo_mini.png
templates/zora/images/logo_petit.png
templates/zora/images/owl.png
templates/zora/inclure/ariane_et_titre_standard.twig
templates/zora/inclure/descriptions/argument.twig
templates/zora/inclure/descriptions/constants.twig
templates/zora/inclure/descriptions/functions.twig
templates/zora/inclure/descriptions/group_content.twig
templates/zora/inclure/descriptions/package.twig
templates/zora/inclure/descriptions/package_link.twig
templates/zora/inclure/descriptions/pipeline.twig
templates/zora/inclure/descriptions/properties.twig
templates/zora/inclure/descriptions/see.twig
templates/zora/inclure/descriptions/summary.twig
templates/zora/inclure/descriptions/tags.twig
templates/zora/inclure/descriptions/types.twig
templates/zora/inclure/head.twig
templates/zora/inclure/liste/packages.twig
templates/zora/inclure/liste/spiperies.twig
templates/zora/inclure/liste/spiperies_with_tabs.twig
templates/zora/inclure/nav-directory.twig
templates/zora/inclure/nav.twig
templates/zora/index.twig
templates/zora/js/dygraph-combined.js
templates/zora/js/jquery.min.js
templates/zora/js/perso.js
templates/zora/last_stat.twig
templates/zora/marqueurs.twig
templates/zora/more/dist.twig
templates/zora/navigation.twig
templates/zora/package.twig
templates/zora/packages.twig
templates/zora/pipeline.twig
templates/zora/pipelines.twig
templates/zora/recherche.twig
templates/zora/recherche_data.twig
templates/zora/statistiques.twig
templates/zora/statistiques.txt
templates/zora/structure.twig
templates/zora/template.xml
templates/zora/z_bloc.twig
Modifié
.gitignore
bin/autodoc
composer.json
composer.lock