ford

Ford

Este é um gerador automático de documentação para os programas modernos da Fortran. Ford significa documentador fortran. Como você deve saber, "To Ford" refere -se a atravessar um rio (ou outro corpo de água). Nesse contexto, não se refere a qualquer empresa ou indivíduo associado aos carros.

A Ford foi escrita devido ao mau manuseio de Fortran pelo Doxygen e à falta de alternativas comparáveis. O Robodoc não pode realmente extrair nenhuma informação do código -fonte e praticamente qualquer outro software de documentação automática que encontrei era proprietário, não funcionou muito bem para a Fortran ou foi limitado em termos de como produziu sua saída. O F90DOC é muito bom e eu consegui modificá -lo para que ele pudesse lidar com a maior parte do Fortran 2003, mas produz documentação bastante feia, não pode fornecer tantas ligações entre diferentes partes da documentação que eu gostaria e é escrito em Perl (que não estou familiarizado e que não possui o tipo de bibliotecas encontradas em Python para produzir conteúdo html).

O objetivo da Ford é poder produzir documentação de maneira confiável para o software FORTRAN moderno, informativo e agradável de se olhar. A documentação deve ser fácil de escrever e não obra dentro do código. Embora nunca seja tão rico em recursos quanto doxygen, espero que a Ford possa fornecer uma boa alternativa para documentar projetos fortran.

Recursos

Os recursos atuais incluem:

• A capacidade de extrair informações sobre variáveis, procedimentos, argumentos de procedimentos, tipos derivados, programas e módulos do código -fonte.
• A capacidade de extrair documentação dos comentários no código -fonte.
• Suporte de látex na documentação usando o Mathjax.
• Documentação pesquisável, usando a pesquisa LUNR.
• Descrição do autor e mídia social (incluindo links do github!).
• Links para baixar o código fonte.
• Links para arquivos individuais, tanto em sua forma bruta quanto em html com destaque da sintaxe.
• Uso do Markdown na documentação do tipo de tipo de tipo.
• links entre partes relacionadas do software.
• Bootstrap CSS para a documentação, tornando -o funcional e bonito.
• Configurações configuráveis.
• Capacidade de criar um conjunto hierárquico de páginas contendo informações gerais, não associadas a uma parte específica do código -fonte.
• Exiba uma entrada para arquivos de origem não Fortran com documentação no nível do arquivo e código destacado sintaxe.

Instalação

A maneira mais simples de instalar a Ford é usar o PIP:

 pip install ford

O PIP lidará automaticamente com todas as dependências para você. Por padrão, isso colocará ford em ~/.local/bin - pode ser necessário adicioná -lo ao seu PATH .

Como alternativa, a Ford está disponível no Homebrew Package Manager para o Mac OS X. Para atualizar o Homebrew e instalar a Ford, executar esses comandos em um terminal:

 brew update
brew install FORD

Se você deseja instalar a última filial de desenvolvimento (mestre) do GitHub, basta adicionar a bandeira --HEAD : brew install --HEAD FORD

A Ford também está disponível no Spack Package Manager, executando o seguinte comando:

 spack install py-ford

Documentação

Documentação mais completa pode ser encontrada nos documentos.

Licença

Este programa é um software livre: você pode redistribuí -lo e/ou modificá -lo nos termos da licença pública geral da GNU, conforme publicado pela Free Software Foundation, versão 3 da licença ou (por sua opção) qualquer versão posterior.

Este programa é distribuído na esperança de que seja útil, mas sem garantia ; sem a garantia implícita de comercialização ou aptidão para uma finalidade específica . Veja a licença pública geral da GNU para obter mais detalhes.

Você deveria ter recebido uma cópia da licença pública geral da GNU junto com este programa. Caso contrário, consulte o site da GNU.

Os documentos produzidos pela Ford são obras derivadas derivadas da entrada usada em sua produção; Eles não são afetados por esta licença.