rosdoc::rdcore Namespace Reference

Classes
class	RosdocContext
Functions
def	compute_relative
def	generate_package_tree
def	html_path
def	instantiate_template
def	li_package_links
def	load_tmpl
Variables
string	_TEMPLATES_DIR = 'templates'

---

Function Documentation

def rosdoc::rdcore::compute_relative	(		src,
			target
	)

Definition at line 229 of file rdcore.py.

def rosdoc::rdcore::generate_package_tree

(

ctx

)

Generate a tree representation of the available packages

Definition at line 297 of file rdcore.py.

def rosdoc::rdcore::html_path	(		package,
			docdir
	)

Definition at line 241 of file rdcore.py.

def rosdoc::rdcore::instantiate_template	(		tmpl,
			vars
	)

Definition at line 285 of file rdcore.py.

def rosdoc::rdcore::li_package_links	(		ctx,
			package,
			packages,
			docdir,
			package_htmldir = None
	)

@param package: current package
@type  package: str
@param packages: list of packages to generate 'li' html links to
@type  packages: [str]

Definition at line 265 of file rdcore.py.

def rosdoc::rdcore::load_tmpl

(

filename

)

Definition at line 250 of file rdcore.py.

---

Variable Documentation

string rosdoc::rdcore::_TEMPLATES_DIR = 'templates'

Definition at line 248 of file rdcore.py.