https://github.com/cmbant/fordocs

Automatic documentation generation from Fortran 2003 code
https://github.com/cmbant/fordocs

documentation-generator fortran2003

Last synced: about 1 month ago
JSON representation

Automatic documentation generation from Fortran 2003 code

• Host: GitHub
• URL: https://github.com/cmbant/fordocs
• Owner: cmbant
• Created: 2014-06-12T10:41:38.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2019-01-07T17:27:03.000Z (over 6 years ago)
• Last Synced: 2025-03-25T09:53:00.634Z (2 months ago)
• Topics: documentation-generator, fortran2003
• Language: Python
• Size: 535 KB
• Stars: 3
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.txt

Awesome Lists containing this project

README

        
Fortran Document Generator Readme

=================================

GitHub Page: https://github.com/cmbant/fordocs

1- Install the requirements from the included requirements.txt:

	pip install -r requirements.txt

2- Using the program:

	This generator will extract the classes, function, subroutine and dependencies from every file (*.f90) of the project.

	In order to use the generator, run the following:

	

	    python fordocs.py  

	

	ex:

	    python fordocs.py cosmomc/source/ fordocs/output

			

	The script will automatically find every file matching the pattern recursively under the SourceDirectory root.

	

Run forfocs.py -h to see list of optional parameters, for example exclusion list:

	usage: fordocs.py [-h] [--file_pattern FILE_PATTERN] [--title TITLE]

                  [--define DEFINE [DEFINE ...]]

                  [--excludes EXCLUDES [EXCLUDES ...]]

                  [--excludes_file EXCLUDES_FILE]

                  source_folders [source_folders ...] output_folder

positional arguments:

  source_folders        The directory in which to search for Fortran files,

                        recursively

  output_folder         The directory in which documentation will be generated

optional arguments:

  -h, --help            show this help message and exit

  --file_pattern FILE_PATTERN

  --title TITLE         The title used in the documentation tab and index link

  --define DEFINE [DEFINE ...]

                        list of preprocessor definitions

  --class_tree_splits CLASS_TREE_SPLITS [CLASS_TREE_SPLITS ...]

                        list of class names to show separately in class tree

                        index (rather than as part of larger big tree)

  --excludes EXCLUDES [EXCLUDES ...]

                        list of file name patterns to exclude

  --excludes_file EXCLUDES_FILE

                        file containing list of file names to exclude