ford

Форд

Это автоматический генератор документов для современных программ Fortran. Ford означает докутор Fortran. Как вы, возможно, знаете, «к Форду» относится к пересечению реки (или другого водоема). В этом контексте он не относится к какой -либо компании или человеку, связанным с автомобилями.

Форд был написан из -за плохого обращения с Фортраном Доксигена и отсутствия сопоставимых альтернатив. Robodoc не может на самом деле извлечь какую -либо информацию из исходного кода, и практически любое другое программное обеспечение для автоматической документации, которое я нашел, было либо запатентованным, не очень хорошо работало для Fortran, либо было ограничено с точки зрения того, как он производил свои результаты. F90DOC довольно хорош, и мне удалось изменить его, чтобы он мог справиться с большей частью Fortran 2003, но он создает довольно уродливую документацию, не может предоставить столько ссылок между различными частями документации, сколько я хотел бы, и написан в Perl (с которыми я не так знаком, и у которых нет таковых библиотек, найденных в Python для создания содержания HTML).

Цель Ford - иметь возможность надежно выпустить документацию для современного программного обеспечения Fortran, которое является информативным и приятным для просмотра. Документация должна быть легко писать и не связать в коде. Хотя он никогда не будет таким богатым функциями, как доксиген, мы надеемся, что Ford сможет предоставить хорошую альтернативу для документирования проектов FORTRAN.

Возможности

Текущие функции включают в себя:

• Возможность извлекать информацию о переменных, процедурах, процедурных аргументах, производных типах, программах и модулях из исходного кода.
• Возможность извлекать документацию из комментариев в исходном коде.
• Поддержка латекса в документации с использованием MathJax.
• Дополнительная документация, используя поиск LUNR.
• Описание автора и социальные сети (включая GitHub!) Ссылки.
• Ссылки для загрузки исходного кода.
• Ссылки на отдельные файлы, как в их необработанной форме, так и в HTML с синтаксисом.
• Использование документирования набора типов.
• Ссылки между связанными частями программного обеспечения.
• Bootstrap CSS для документации, что делает его функциональным и красивым.
• настраиваемые настройки.
• Возможность создавать иерархический набор страниц, содержащих общую информацию, не связанную с какой -либо конкретной частью исходного кода.
• Отобразите запись для нефтранских исходных файлов с документацией на уровне файлов и синтаксисом, выделенным.

Установка

Самый простой способ установки Ford - это использование PIP:

 pip install ford

PIP автоматически обрабатывает все зависимости для вас. По умолчанию это поместит ford в ~/.local/bin - вам может потребоваться добавить это на свой PATH .

В качестве альтернативы, Ford доступен через диспетчер пакетов Homebrew для Mac OS X. Чтобы обновить Homebrew и установить Ford, запустите эти команды в терминале:

 brew update
brew install FORD

Если вы хотите установить новейшую ветвь разработки (Master) из GitHub, просто добавьте флаг --HEAD : brew install --HEAD FORD

Ford также доступен через диспетчер пакетов Spack, выполнив следующую команду:

 spack install py-ford

Документация

Более полную документацию можно найти в документах.

Лицензия

Эта программа является бесплатным программным обеспечением: вы можете перераспределить его и/или изменить ее в соответствии с условиями общей публичной лицензии GNU, опубликованных Фондом Free Software, либо версией 3 лицензии, либо (по варианту) любой более поздней версии.

Эта программа распространяется в надежде, что она будет полезна, но без какой -либо газа ; даже без подразумеваемой гарантии торговой точки зрения или пригодности для определенной цели . Смотрите общую публичную лицензию GNU для получения более подробной информации.

Вы должны были получить копию общей публичной лицензии GNU вместе с этой программой. Если нет, см. Веб -сайт GNU.

Документы, произведенные Ford, являются производными работами, полученными от входных данных, используемых в их производстве; Они не затронуты этой лицензией.