rosdoc::landing_page Namespace Reference

Functions
def	_href
def	generate_landing_page
	Generate landing page in the event that there are multiple documentation sets.
def	generate_links
def	link_name
def	output_location

---

Function Documentation

def rosdoc::landing_page::_href	(		location,
			text
	)			[private]

Definition at line 46 of file landing_page.py.

def rosdoc::landing_page::generate_landing_page

(

ctx

)

Generate landing page in the event that there are multiple documentation sets.

Returns:

[str]: list of packages for which there are landing pages generated

Definition at line 106 of file landing_page.py.

def rosdoc::landing_page::generate_links	(		ctx,
			package,
			base_dir,
			rd_configs
	)

Definition at line 69 of file landing_page.py.

def rosdoc::landing_page::link_name

(

rd_config

)

Definition at line 49 of file landing_page.py.

def rosdoc::landing_page::output_location

(

config

)

Definition at line 63 of file landing_page.py.