update-links Namespace Reference

Functions
def	readLayout
def	pageLink
def	updateAFile
def	main

Variables
list	lay_tree = []

Function Documentation

def update-links.main

(

)

Main function that is called when the module is loaded by itself

The function assumes that the documentation is in the same directory.

Definition at line 144 of file update-links.py.

References readLayout(), and updateAFile().

def update-links.pageLink	(		page_name,
			link_text
	)

get the text to be used as a link to the page

Definition at line 56 of file update-links.py.

Here is the caller graph for this function:

def update-links.readLayout

(

lay_p

)

Reads the layout.ini file into a global data structure - lay_tree

lay_p indicates the path to the layout file.
Returns False for error, True for success

Definition at line 11 of file update-links.py.

Here is the caller graph for this function:

def update-links.updateAFile	(		dox_file_p,
			fileindex
	)

updats dynamic data between the markers

The function reads the file and modified the content between the
markers.

Definition at line 71 of file update-links.py.

References pageLink().

Here is the caller graph for this function:

Variable Documentation

list update-links.lay_tree = []

Definition at line 9 of file update-links.py.