ford

MENGARUNGI

Ini adalah generator dokumentasi otomatis untuk program Fortran modern. Ford adalah singkatan dari Fortran Documenter. Seperti yang Anda ketahui, "ke Ford" mengacu pada menyeberangi sungai (atau badan air lainnya). Tidak, dalam konteks ini, merujuk ke perusahaan atau individu yang terkait dengan mobil.

Ford ditulis karena penanganan Fortran Doxygen yang buruk dan kurangnya alternatif yang sebanding. Robodoc tidak dapat benar -benar mengekstrak informasi apa pun dari kode sumber dan hampir semua perangkat lunak dokumentasi otomatis lainnya yang saya temukan adalah hak milik, tidak bekerja dengan baik untuk Fortran, atau terbatas dalam hal bagaimana menghasilkan outputnya. F90DOC cukup bagus dan saya berhasil memodifikasinya sehingga dapat menangani sebagian besar Fortran 2003, tetapi menghasilkan dokumentasi yang agak buruk, tidak dapat menyediakan banyak tautan antara berbagai bagian dokumentasi seperti yang saya inginkan, dan ditulis dalam Perl (yang tidak saya kenal dan yang tidak memiliki jenis perpustakaan yang ditemukan dalam Python untuk menghasilkan konten HTML).

Tujuan Ford adalah untuk dapat menghasilkan dokumentasi yang andal untuk perangkat lunak Fortran modern yang informatif dan menyenangkan untuk dilihat. Dokumentasi harus mudah ditulis dan tidak mencolok dalam kode. Meskipun tidak akan pernah sama kaya fiturnya dengan Doxygen, semoga Ford akan dapat memberikan alternatif yang baik untuk mendokumentasikan proyek Fortran.

Kemampuan

Fitur saat ini meliputi:

• Kemampuan untuk mengekstrak informasi tentang variabel, prosedur, argumen prosedur, jenis turunan, program, dan modul dari kode sumber.
• Kemampuan untuk mengekstrak dokumentasi dari komentar dalam kode sumber.
• Dukungan Lateks dalam Dokumentasi Menggunakan Mathjax.
• Dokumentasi yang dapat dicari, menggunakan pencarian Lunr.
• Deskripsi Penulis dan Media Sosial (termasuk GitHub!) Tautan.
• Tautan untuk mengunduh kode sumber.
• Tautan ke masing -masing file, baik dalam bentuk mentah mereka atau di HTML dengan penyorotan sintaks.
• Penggunaan Markdown ke Dokumentasi Tipe-Set.
• Tautan antara bagian -bagian terkait dari perangkat lunak.
• Bootstrap CSS untuk dokumentasi, menjadikannya fungsional dan cantik.
• Pengaturan yang dapat dikonfigurasi.
• Kemampuan untuk membuat serangkaian halaman hierarkis yang berisi informasi umum, tidak terkait dengan bagian tertentu dari kode sumber.
• Tampilkan entri untuk file sumber non-fortran dengan dokumentasi tingkat file dan kode yang disorot sintaks.

Instalasi

Cara paling sederhana untuk menginstal Ford adalah menggunakan PIP:

 pip install ford

PIP akan secara otomatis menangani semua dependensi untuk Anda. Secara default ini akan menempatkan ford di ~/.local/bin - Anda mungkin perlu menambahkan ini ke PATH Anda.

Atau, Ford tersedia melalui Homebrew Package Manager untuk Mac OS X. Untuk memperbarui Homebrew dan menginstal Ford, jalankan perintah ini di terminal:

 brew update
brew install FORD

Jika Anda ingin menginstal Cabang Pengembangan (Master) terbaru dari GitHub, cukup tambahkan bendera --HEAD : brew install --HEAD FORD

Ford juga tersedia melalui manajer paket Spack dengan menjalankan perintah berikut:

 spack install py-ford

Dokumentasi

Dokumentasi yang lebih lengkap dapat ditemukan di dokumen.

Lisensi

Program ini adalah perangkat lunak gratis: Anda dapat mendistribusikannya kembali dan/atau memodifikasinya berdasarkan ketentuan lisensi publik umum GNU seperti yang diterbitkan oleh Yayasan Perangkat Lunak Gratis, baik versi 3 lisensi, atau (pada opsi Anda) versi selanjutnya.

Program ini didistribusikan dengan harapan akan bermanfaat, tetapi tanpa warrenty ; bahkan tanpa jaminan tersirat dari dapat diperjualbelikan atau kebugaran untuk tujuan tertentu . Lihat Lisensi Publik Umum GNU untuk lebih jelasnya.

Anda seharusnya menerima salinan Lisensi Publik Umum GNU bersama dengan program ini. Jika tidak, lihat situs web GNU.

Dokumen yang diproduksi oleh Ford adalah karya turunan yang berasal dari input yang digunakan dalam produksinya; Mereka tidak terpengaruh oleh lisensi ini.