Command Line Options

The command-line interface is given below:

usage: ford.py [-h] [-d PROJECT_DIR] [-o OUTPUT_DIR] [-s CSS]
               [--exclude EXCLUDE] [-e [EXTENSIONS [EXTENSIONS ...]]] [-w]
               [--no-warn] [-V]
               project_file

####PROJECT_DIR The directory where the source-files are to be found for this project. This must not be a subdirectory of the OUTPUT_DIR (see below). (default: ./src) ####OUTPUT_DIR The directory where the project output will be placed. Any content already present there will be deleted. (default: ./doc) ####CSS The path to a custom style-sheet which can be used to modify the appearance of the output. ####EXCLUDE A source file which should not be read. If you want to specify more than one then you will need to do it in the project file. ####EXTENSIONS File extensions which will be read by FORD for documentation. (default: f90, f95, f03, f08) ####-w/--warn Print warnings for every undocumented item encountered. (Warning: This feature is not yet available in the version of Ford hosted on PyPI. It can only be downloaded from Github at this time.) ####--no-warn Do not print warnings for every undocumented item encountered. This is the default behaviour. (Warning: This feature is not yet available in the version of Ford hosted on PyPI. It can only be downloaded from Github at this time.) ####project_file The file containing a description of your project and various settings for FORD.

---

Settings specified at the command-line will override those specified in the project file.