runDoxygen Namespace Reference

Functions
	replace_string_in_file (file_path, old_string, new_string)
	search_and_replace_in_directory (directory, old_string, new_string)

Variables
str	ROOT_DIR = "C:/Users/david/Documents/PlatformIO/Solo_Controller/"
str	HTML_DIR = ROOT_DIR + "DVititoe.github.io/Solo_Controller/html/"
str	directory_to_search = HTML_DIR
str	old_string = r'<img src="[^"]*images/'
str	new_string = '<img src="'
str	images_dir = ROOT_DIR + "Solo_Controller_Repo/images/"
str	doc_dir = ROOT_DIR + "Solo_Controller_Repo/docs/"
str	dest_dir = HTML_DIR + "docs/"
str	extension = ".pdf"
	s = os.path.join(doc_dir, item)
	d = os.path.join(dest_dir, item)
str	dest_file = HTML_DIR + "BOM/Controller_Board_BOM.html"
str	bom_file = ROOT_DIR + "Solo_Controller_Repo/Kicad/Controller_Board/BOM/ibom.html"

Function Documentation

replace_string_in_file()

runDoxygen.replace_string_in_file	(		file_path,
			old_string,
			new_string )

Replace all occurrences of `old_string` with `new_string` in the given file.

search_and_replace_in_directory()

runDoxygen.search_and_replace_in_directory	(		directory,
			old_string,
			new_string )

Recursively search through HTML files in the given directory and replace the old string with the new string.
Uses regular expressions for the string replacement.

Variable Documentation

bom_file

str runDoxygen.bom_file = ROOT_DIR + "Solo_Controller_Repo/Kicad/Controller_Board/BOM/ibom.html"

d

runDoxygen.d = os.path.join(dest_dir, item)

dest_dir

str runDoxygen.dest_dir = HTML_DIR + "docs/"

dest_file

str runDoxygen.dest_file = HTML_DIR + "BOM/Controller_Board_BOM.html"

directory_to_search

str runDoxygen.directory_to_search = HTML_DIR

doc_dir

str runDoxygen.doc_dir = ROOT_DIR + "Solo_Controller_Repo/docs/"

extension

str runDoxygen.extension = ".pdf"

HTML_DIR

str runDoxygen.HTML_DIR = ROOT_DIR + "DVititoe.github.io/Solo_Controller/html/"

images_dir

str runDoxygen.images_dir = ROOT_DIR + "Solo_Controller_Repo/images/"

new_string

str runDoxygen.new_string = '<img src="'

old_string

str runDoxygen.old_string = r'<img src="[^"]*images/'

ROOT_DIR

str runDoxygen.ROOT_DIR = "C:/Users/david/Documents/PlatformIO/Solo_Controller/"

s

runDoxygen.s = os.path.join(doc_dir, item)