ford

GUÉ

Il s'agit d'un générateur de documentation automatique pour les programmes FORTRAN modernes. Ford signifie Fortran Documenter. Comme vous le savez peut-être, "To Ford" fait référence à la traversée d'une rivière (ou d'un autre plan d'eau). Dans ce contexte, il ne fait pas référence à une entreprise ou à une personne associée aux voitures.

Ford a été écrit en raison de la mauvaise gestion de Doxygen de Fortran et du manque d'alternatives comparables. Robodoc ne peut pas réellement extraire aucune information du code source et à peu près tout autre logiciel de documentation automatique que j'ai trouvé était soit propriétaire, ne fonctionnait pas très bien pour Fortran, soit limité en termes de façon de produire sa sortie. F90DOC est assez bon et j'ai réussi à le modifier afin qu'il puisse gérer la plupart de Fortran 2003, mais il produit une documentation plutôt laide, ne peut pas fournir autant de liens entre les différentes parties de la documentation que je le souhaite, et est écrit dans Perl (que je ne suis pas si familier et qui manque le type de bibliothèques trouvées dans Python pour produire du contenu HTML).

L'objectif de Ford est de pouvoir produire de manière fiable la documentation pour le logiciel Fortran moderne qui est informatif et agréable à regarder. La documentation doit être facile à écrire et non passive dans le code. Bien qu'il ne soit jamais aussi riche en fonctionnalités que Doxygen, j'espère que Ford sera en mesure de fournir une bonne alternative pour documenter les projets Fortran.

Capacités

Les fonctionnalités actuelles comprennent:

• La capacité d'extraire des informations sur les variables, les procédures, les arguments de procédure, les types dérivés, les programmes et les modules du code source.
• la possibilité d'extraire la documentation à partir de commentaires dans le code source.
• Support de latex dans la documentation à l'aide de Mathjax.
• Documentation consultable, en utilisant la recherche LUNR.
• Description de l'auteur et des liens sur les réseaux sociaux (y compris GitHub!).
• Liens pour télécharger le code source.
• Liens vers des fichiers individuels, à la fois sous leur forme brute ou dans HTML avec la mise en évidence de la syntaxe.
• Utilisation de la documentation Markdown pour set.
• Liens entre les parties connexes du logiciel.
• Bootstrap CSS pour la documentation, ce qui le rend à la fois fonctionnel et joli.
• Paramètres configurables.
• Capacité à créer un ensemble hiérarchique de pages contenant des informations générales, non associées à une partie particulière du code source.
• Affichez une entrée pour les fichiers source non-FORTRAN avec la documentation au niveau du fichier et le code surligné par syntaxe.

Installation

La façon la plus simple d'installer Ford est d'utiliser PIP:

 pip install ford

PIP gérera automatiquement toutes les dépendances pour vous. Par défaut, cela placera ford dans ~/.local/bin - vous devrez peut-être l'ajouter à votre PATH .

Alternativement, Ford est disponible via le Homebrew Package Manager pour Mac OS X. Pour mettre à jour Homebrew et installer Ford, exécutez ces commandes dans un terminal:

 brew update
brew install FORD

Si vous souhaitez installer la dernière branche de développement (maître) de GitHub, ajoutez simplement l'installation --HEAD brew install --HEAD FORD

Ford est également disponible via le Spack Package Manager en exécutant la commande suivante:

 spack install py-ford

Documentation

Une documentation plus complète peut être trouvée dans les documents.

Licence

Ce programme est un logiciel gratuit: vous pouvez le redistribuer et / ou le modifier en vertu des termes de la licence publique générale GNU publiée par la Free Software Foundation, soit la version 3 de la licence, ou (à votre option) toute version ultérieure.

Ce programme est distribué dans l'espoir qu'il sera utile, mais sans aucune garantie ; Sans même la garantie implicite de qualité marchande ou d'adéquation à un usage particulier . Voir la licence publique générale GNU pour plus de détails.

Vous devriez avoir reçu une copie de la licence publique générale GNU avec ce programme. Sinon, consultez le site Web GNU.

Les documents produits par Ford sont des travaux dérivés dérivés de l'entrée utilisée dans leur production; Ils ne sont pas affectés par cette licence.