fortplot_documentation Module

Consolidated documentation generation module combining core utilities, processing logic, and output generation


Uses


Variables

Type Visibility Attributes Name Initial
integer, public, parameter :: PATH_MAX_LEN = 256
integer, public, parameter :: FILENAME_MAX_LEN = 256
integer, public, parameter :: LINE_MAX_LEN = 1024
integer, public, parameter :: MAX_EXAMPLES = 64
integer, public, parameter :: MAX_MEDIA_FILES = 32
integer, public, parameter :: VIDEO_WIDTH = 800
integer, public, parameter :: VIDEO_HEIGHT = 600
character(len=*), public, parameter :: GITHUB_BASE_URL = 'https://github.com/lazy-fortran/fortplot/blob/main/'

Functions

public function get_output_title(filename) result(title)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: filename

Return Value character(len=:), allocatable

public function get_example_count() result(count)

Arguments

None

Return Value integer


Subroutines

public subroutine copy_file_content(input_file, output_file)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: input_file
character(len=*), intent(in) :: output_file

public pure subroutine build_readme_path(example_dir, readme_file)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: example_dir
character(len=PATH_MAX_LEN), intent(out) :: readme_file

public pure subroutine build_output_path(example_name, output_file)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: example_name
character(len=PATH_MAX_LEN), intent(out) :: output_file

public pure subroutine build_fortran_url(example_name, fortran_path)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: example_name
character(len=PATH_MAX_LEN), intent(out) :: fortran_path

public pure subroutine build_python_path(example_name, python_path)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: example_name
character(len=PATH_MAX_LEN), intent(out) :: python_path

public pure subroutine build_local_fortran_path(example_name, local_path)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: example_name
character(len=PATH_MAX_LEN), intent(out) :: local_path

public pure subroutine get_fortran_filename(example_name, filename)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: example_name
character(len=PATH_MAX_LEN), intent(out) :: filename

public pure subroutine get_example_run_target(example_name, run_target)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: example_name
character(len=PATH_MAX_LEN), intent(out) :: run_target

public subroutine get_example_dir(index, dir)

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: index
character(len=PATH_MAX_LEN), intent(out) :: dir

public subroutine get_example_name(index, name)

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: index
character(len=PATH_MAX_LEN), intent(out) :: name

public subroutine process_example(example_dir, example_name)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: example_dir
character(len=*), intent(in) :: example_name

public subroutine write_generated_outputs(unit_out, example_dir, example_name)

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: unit_out
character(len=*), intent(in) :: example_dir
character(len=*), intent(in) :: example_name

public subroutine scan_directory_for_media(dir_path, media_files, n_media)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: dir_path
character(len=*), intent(out) :: media_files(MAX_MEDIA_FILES)
integer, intent(out) :: n_media