build_pin_list Namespace Reference

Functions
str	get_git_file_modified_info (Path|str file_path)
pl.DataFrame	read_ioc_file (Path|str ioc_file_path)
pl.DataFrame	make_pin_table (Path|str ioc_file_path)
	generate_markdown_table_file (Path|str ioc_file_path, Path|str output_path)
	main ()

Variables
str	MD_FILE_TEMPLATE

Detailed Description

Generate a list of pins, in a Markdown file, from the IOC file.

Run this script with:
```bash
pip install uv

uv run docs/generation/build_pin_list.py
```

The `uv` tool automatically installs the required dependencies specified in the `dependencies`
section below.

Function Documentation

generate_markdown_table_file()

build_pin_list.generate_markdown_table_file	(	Path | str	ioc_file_path,
		Path | str	output_path )

Writes the pin table as a Markdown file.

Here is the call graph for this function:

Here is the caller graph for this function:

get_git_file_modified_info()

str build_pin_list.get_git_file_modified_info

(

Path | str

file_path

)

Returns the last modified date of the file, according to Git.

Returns a string with the full date and time, and the short commit hash.

Here is the caller graph for this function:

main()

build_pin_list.main

(

void

)

Here is the call graph for this function:

Here is the caller graph for this function:

make_pin_table()

pl.DataFrame build_pin_list.make_pin_table

(

Path | str

ioc_file_path

)

Generates a table of pins from the IOC file.

Each row is a pin (with a Pin ID like 'PA0').
Columns are human-readable names (e.g., 'GPIO Pin Label').

Here is the call graph for this function:

Here is the caller graph for this function:

read_ioc_file()

pl.DataFrame build_pin_list.read_ioc_file

(

Path | str

ioc_file_path

)

Reads the IOC file and returns a DataFrame.
Has columns: ["parameter", "value"]

Here is the caller graph for this function:

Variable Documentation

MD_FILE_TEMPLATE

str build_pin_list.MD_FILE_TEMPLATE

Initial value:

=  """\
# Pin List (from IOC file)
 
This is an auto-generated list of pins from the IOC file. It is generated by the
[`{this_script_file_name}` script]({this_script_file_path}).
 
This is a representation of the IOC file, as of `{file_save_id}`.
 
{pin_count} pins are used.
 
## Table
 
{pin_table}
"""