Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 570 Bytes

Readme_docs.md

File metadata and controls

21 lines (14 loc) · 570 Bytes

Document generation

The inline Fortran documentation is Markdown-based, using FORD. If source code or documentation edits are made, the documentation is regenerated from the top-level gemini directory by:

ford ford.md

The output is under doc/ and upon git push will appear at the GEMINI docs website.

Install FORD

FORD is a Python program, installed via:

pip install ford

Note: leave the LaTeX files and other non-autogenerated documents in docs/ so they don't get disturbed by FORD.