Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexbuccheri/ford_example
https://github.com/alexbuccheri/ford_example
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/alexbuccheri/ford_example
- Owner: AlexBuccheri
- Created: 2021-01-13T19:57:36.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-03T17:20:53.000Z (almost 2 years ago)
- Last Synced: 2024-10-28T10:28:32.467Z (3 months ago)
- Language: Fortran
- Size: 35.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ReadMe
## Installation
Ford can be installed with pip. One has to make sure Markdown is also up-to-date. Additionally, graphviz is required for the generation of dependency graphs:
`pip install ford Markdown graphviz`.
Doxygen is available with most package managers i.e. macports, apt-get.
## Compiling the Documentation with CMake
To configure CMake with Ford support and compile the documentation:
```
mkdir build && cd build
cmake ../ -DENABLE_DOCS=FORD
make docs
```
To configure CMake with doxygen support and compile the documentation:
```
mkdir build && cd build
cmake ../ -DENABLE_DOCS=DOXYGEN
make docs
```
CMake will execute the appropriate command to generate the documentation. Ford documentation is built in `documentation/ford`, and doxygen documentation is built in `documentation/doxy`. In both cases, the html file can be loaded by double-clicking `index.html `
## Compiling the Documentation Manually
For Ford, run the following command in the root folder:
`ford -o documentation/ford project-description.md`.
For Doxygen, one needs to modify the file paths in the `Doxyfile` file because they're relative and cannot be passed to `doxygen` as arguments. They're set to work with the expected location of the CMake build directory by default. One should change the variables to:
```
INPUT = ./src
OUTPUT_DIRECTORY = ./documentation/doxy
```
Once modified, run the following command in the root folder:
`doxygen Doxyfile`.
If the Doxygen configuration file is missing, one can also run:
`doxygen -g`,
to generate a configuration file, which can then be modified accordingly.
## Useful References
Valid at the time of writing:
* [Documentation options for fortran](https://cyber.dabamos.de/programming/modernfortran/source-code-documentation.html)
* [Examples from which this doxygen documentation was based on](https://dannyvanpoucke.be/oop-fortran-tut6-en/)