ford

フォード

これは、最新のFortranプログラム向けの自動ドキュメントジェネレーターです。 FordはFortranドキュメンターの略です。ご存知かもしれませんが、「フォードへ」とは、川（または他の水域）を渡ることを指します。この文脈では、車に関連する会社または個人を参照しません。

フォードは、DoxygenのFortranの取り扱いが不十分であり、同等の選択肢がないために書かれました。 Robodocは実際にソースコードから情報を抽出することはできず、私が見つけた他のほぼすべての自動ドキュメンテーションソフトウェアは、所有権、Fortranにとってあまりうまく機能しなかったか、その出力をどのように生成したかという点で制限されていました。 F90DOCは非常に優れており、Fortran 2003の大部分を処理できるように変更することができましたが、かなりugいドキュメントを作成し、ドキュメントの異なる部分の間に私が望むほど多くのリンクを提供することはできません。

フォードの目標は、有益で有益な最新のFortranソフトウェア向けのドキュメントを確実に作成できることです。ドキュメントは、簡単に書き込み、コード内で非難されない必要があります。 Doxygenほど機能が豊富になることはありませんが、FordがFortranプロジェクトを文書化するための優れた代替手段を提供できることを願っています。

機能

現在の機能は次のとおりです。

• ソースコードから変数、手順、手順引数、派生したタイプ、プログラム、およびモジュールに関する情報を抽出する機能。
• ソースコードのコメントからドキュメントを抽出する機能。
• Mathjaxを使用したドキュメントでのラテックスサポート。
• LUNR検索を使用した検索可能なドキュメント。
• 著者の説明とソーシャルメディア（GitHub！を含む！）リンク。
• ソースコードをダウンロードするためのリンク。
• 個々のファイルへのリンクは、生の形式または構文の強調表示を備えたHTMLの両方で。
• タイプセットドキュメントへのマークダウンの使用。
• ソフトウェアの関連部分間のリンク。
• ドキュメント用のブートストラップCSS。機能的できれいになります。
• 設定可能な設定。
• ソースコードの特定の部分に関連付けられていない一般情報を含むページの階層セットを作成する機能。
• ファイルレベルのドキュメントと構文強調表示されたコードを使用して、非フォルトソースファイルのエントリを表示します。

インストール

Fordをインストールする最も簡単な方法は、PIPを使用することです。

 pip install ford

PIPは、すべての依存関係を自動的に処理します。デフォルトでは、これによりford ~/.local/binに配置されます。これをPATHに追加する必要がある場合があります。

または、FordはMac OS XのHomeBrewパッケージマネージャーから入手できます。HomeBrewを更新してFordをインストールするには、これらのコマンドをターミナルで実行します。

 brew update
brew install FORD

GitHubから最新の開発（マスター）ブランチをインストールしたい場合は、 --HEAD Flag： brew install --HEAD FORDを追加するだけです

Fordは、次のコマンドを実行することで、Spack Package Managerからも利用できます。

 spack install py-ford

ドキュメント

より完全なドキュメントは、ドキュメントに記載されています。

ライセンス

このプログラムはフリーソフトウェアです。フリーソフトウェアファンデーションの条件、ライセンスのバージョン3、または（オプションで）後のバージョンのいずれかで公開されているように、GNU一般公開ライセンスの条件の下でそれを再配布したり、変更したりできます。

このプログラムは、それが有用であることを期待して配布されますが、保証されていません。商品性や特定の目的に対するフィットネスの暗黙の保証さえありません。詳細については、GNU一般公開ライセンスを参照してください。

このプログラムとともに、GNU一般公開ライセンスのコピーを受け取る必要があります。そうでない場合は、GNUのWebサイトをご覧ください。

Fordが作成した文書は、生産で使用される入力から派生した派生作品です。彼らはこのライセンスの影響を受けません。