ford

VADO

Este es un generador de documentación automático para programas modernos de Fortran. Ford significa Fortran Documenter. Como sabrán, "a Ford" se refiere a cruzar un río (u otro cuerpo de agua). En este contexto, no se refiere a ninguna empresa o individuo asociado con los automóviles.

Ford fue escrito debido al mal manejo de Doxygen de Fortran y la falta de alternativas comparables. Robodoc no puede extraer ninguna información del código fuente y casi cualquier otro software de documentación automático que encontré era patentado, no funcionaba muy bien para Fortran o estaba limitado en términos de cómo produjo su salida. F90DOC es bastante bueno y logré modificarlo para que pueda manejar la mayor parte de Fortran 2003, pero produce una documentación bastante fea, no puedo proporcionar tantos enlaces entre diferentes partes de la documentación como me gustaría, y está escrito en Perl (con lo que no estoy tan familiarizado y que carece del tipo de bibliotecas que se encuentran en Python para producir contenido de HTML).

El objetivo de Ford es poder producir documentación de manera confiable para el software moderno de Fortran, que es informativo y agradable de ver. La documentación debe ser fácil de escribir y no obtrusive dentro del código. Si bien nunca será tan rico en funciones como Doxygen, con suerte Ford podrá proporcionar una buena alternativa para documentar proyectos de Fortran.

Capacidades

Las características actuales incluyen:

• La capacidad de extraer información sobre variables, procedimientos, argumentos de procedimientos, tipos derivados, programas y módulos del código fuente.
• La capacidad de extraer documentación de los comentarios en el código fuente.
• Soporte de látex en la documentación utilizando MathJax.
• Documentación de búsqueda, utilizando la búsqueda de LUNR.
• Descripción del autor y redes sociales (¡incluidos GitHub!) Enlaces.
• Enlaces para descargar el código fuente.
• Enlaces a archivos individuales, tanto en su forma sin procesar como en HTML con resaltado de sintaxis.
• Uso de Markdown a la documentación del tipo de tipo.
• Enlaces entre partes relacionadas del software.
• Bootstrap CSS para la documentación, por lo que es funcional y bonita.
• Configuración configurable.
• Capacidad para crear un conjunto jerárquico de páginas que contienen información general, no asociada con ninguna parte particular del código fuente.
• Muestre una entrada para archivos de origen no fortano con documentación a nivel de archivo y código resaltado de sintaxis.

Instalación

La forma más sencilla de instalar Ford es usar PIP:

 pip install ford

PIP manejará automáticamente todas las dependencias para usted. Por defecto, esto colocará ford en ~/.local/bin : es posible que deba agregar esto a su PATH .

Alternativamente, Ford está disponible a través del Administrador de paquetes HomeBrew para Mac OS X. Para actualizar Homebrew e instalar Ford, ejecute estos comandos en un terminal:

 brew update
brew install FORD

Si desea instalar la última rama de desarrollo (maestro) desde GitHub, simplemente agregue la bandera --HEAD : brew install --HEAD FORD

Ford también está disponible a través del Administrador de paquetes Spack ejecutando el siguiente comando:

 spack install py-ford

Documentación

Se puede encontrar una documentación más completa en los documentos.

Licencia

Este programa es un software gratuito: puede redistribuirlo y/o modificarlo bajo los términos de la Licencia Pública General de GNU publicada por Free Software Foundation, ya sea la versión 3 de la licencia o (a su opción) cualquier versión posterior.

Este programa se distribuye con la esperanza de que sea útil, pero sin ninguna guerra ; Sin siquiera la garantía implícita de comerciabilidad o estado físico para un propósito particular . Vea la Licencia Pública General de GNU para más detalles.

Debería haber recibido una copia de la Licencia Pública General de GNU junto con este programa. Si no, consulte el sitio web de GNU.

Los documentos producidos por Ford son obras derivadas derivadas de la entrada utilizada en su producción; No se ven afectados por esta licencia.