Classes | |
| class | UtilException |
Functions | |
| def | _load_manifest |
| def | _load_manifest_file |
| def | ahref |
| def | get_package_versions |
| def | get_repo_li |
| def | get_vcs_li |
| def | load_package_manifest |
| def | load_repo_manifest |
| def | load_stack_manifest |
| def | load_stack_release |
| def | msg_doc_link |
| def | msg_link |
| def | package_html_link |
| def | package_manifest_file |
| def | package_manifest_link |
| def | process_distro |
| def | repo_manifest_file |
| def | repo_manifest_link |
| def | srv_link |
| def | stack_manifest_file |
| def | stack_manifest_link |
| def | sub_link |
| def | wiki_url |
Variables | |
| string | CONTRIBUTE_TMPL |
| list | distro_names = ['boxturtle', 'cturtle', 'diamondback', 'electric', 'unstable'] |
| list | distro_names_indexed = ['diamondback', 'electric', 'unstable'] |
| string | doc_path = '/var/www/www.ros.org/html/doc/' |
| string | doc_url = "http://ros.org/doc/" |
| def macro::macroutils::_load_manifest | ( | url, | ||
| name, | ||||
type_ = 'package' | ||||
| ) | [private] |
Load manifest.yaml properties into dictionary for package @param url: URL to load manifest data from @param name: printable name (for debugging) @return: manifest properties dictionary @raise UtilException: if unable to load. Text of error message is human-readable
Definition at line 180 of file macroutils.py.
| def macro::macroutils::_load_manifest_file | ( | filename, | ||
| name, | ||||
type_ = 'package' | ||||
| ) | [private] |
Load manifest.yaml properties into dictionary for package @param filename: file to load manifest data from @param name: printable name (for debugging) @return: manifest properties dictionary @raise UtilException: if unable to load. Text of error message is human-readable
Definition at line 199 of file macroutils.py.
| def macro::macroutils::ahref | ( | url, | ||
| text | ||||
| ) |
create HTML link to specified URL with link text
Definition at line 24 of file macroutils.py.
| def macro::macroutils::get_package_versions | ( | package | ) |
Definition at line 76 of file macroutils.py.
| def macro::macroutils::get_repo_li | ( | macro, | ||
| props | ||||
| ) |
Get list item HTML for repository URL @param macro: Moin macro object @param props: package/stack manifest dictionary
Definition at line 126 of file macroutils.py.
| def macro::macroutils::get_vcs_li | ( | macro, | ||
| stack_data | ||||
| ) |
Definition at line 139 of file macroutils.py.
| def macro::macroutils::load_package_manifest | ( | package_name, | ||
distro = None | ||||
| ) |
Load manifest.yaml properties into dictionary for package @param lang: optional language argument for localization, e.g. 'ja' @return: manifest properties dictionary @raise UtilException: if unable to load. Text of error message is human-readable
Definition at line 220 of file macroutils.py.
| def macro::macroutils::load_repo_manifest | ( | repo_name | ) |
Load repo.yaml properties into dictionary for package @param lang: optional language argument for localization, e.g. 'ja' @return: manifest properties dictionary @raise UtilException: if unable to load. Text of error message is human-readable
Definition at line 229 of file macroutils.py.
| def macro::macroutils::load_stack_manifest | ( | stack_name, | ||
distro = None | ||||
| ) |
Load stack.yaml properties into dictionary for package @param lang: optional language argument for localization, e.g. 'ja' @return: stack manifest properties dictionary @raise UtilException: if unable to load. Text of error message is human-readable
Definition at line 242 of file macroutils.py.
| def macro::macroutils::load_stack_release | ( | release_name, | ||
| stack_name | ||||
| ) |
load in distro release info for stack
Definition at line 162 of file macroutils.py.
| def macro::macroutils::msg_doc_link | ( | package, | ||
| link_title, | ||||
distro = None | ||||
| ) |
Definition at line 92 of file macroutils.py.
| def macro::macroutils::msg_link | ( | package, | ||
| msg | ||||
| ) |
Definition at line 96 of file macroutils.py.
| def macro::macroutils::package_html_link | ( | package, | ||
distro = None | ||||
| ) |
Generate link to auto-generated package HTML documentation
Definition at line 83 of file macroutils.py.
| def macro::macroutils::package_manifest_file | ( | package, | ||
distro = None | ||||
| ) |
Generate filesystem path to manifest.yaml for package
Definition at line 67 of file macroutils.py.
| def macro::macroutils::package_manifest_link | ( | package, | ||
distro = None | ||||
| ) |
Generate link to manifest.yaml for package
Definition at line 58 of file macroutils.py.
| def macro::macroutils::process_distro | ( | stack_name, | ||
| yaml_str | ||||
| ) |
@return: distro properties, stack properties. Stack properties is just for convenience as it is part of distro properties
Definition at line 154 of file macroutils.py.
| def macro::macroutils::repo_manifest_file | ( | repo | ) |
Generate filesystem path to stack.yaml for package
Definition at line 46 of file macroutils.py.
| def macro::macroutils::repo_manifest_link | ( | repo | ) |
Generate link to repo.yaml for repository
Definition at line 52 of file macroutils.py.
| def macro::macroutils::srv_link | ( | package, | ||
| srv | ||||
| ) |
Definition at line 100 of file macroutils.py.
| def macro::macroutils::stack_manifest_file | ( | stack, | ||
distro = None | ||||
| ) |
Generate filesystem path to stack.yaml for package
Definition at line 37 of file macroutils.py.
| def macro::macroutils::stack_manifest_link | ( | stack, | ||
distro = None | ||||
| ) |
Generate link to stack.yaml for package
Definition at line 28 of file macroutils.py.
| def macro::macroutils::sub_link | ( | macro, | ||
| page, | ||||
| sub, | ||||
title = None | ||||
| ) |
Generate link to wiki subpage @param macro: macro instance @param page: current page name @param sub: sub page name @param title: (optional) link text
Definition at line 104 of file macroutils.py.
| def macro::macroutils::wiki_url | ( | macro, | ||
| page, | ||||
shorten = None | ||||
| ) |
Create link to ROS wiki page
Definition at line 116 of file macroutils.py.
"""Cannot load information on <strong>%(name)s</strong>, which means that it is not yet in our index. Please see <a href="http://www.ros.org/wiki/Get%%20Involved#Documenting_Your_.2A-ros-pkg_Repository_on_ROS.org">this page</a> for information on how to submit your repository to our index."""
Definition at line 19 of file macroutils.py.
| list macro::macroutils::distro_names = ['boxturtle', 'cturtle', 'diamondback', 'electric', 'unstable'] |
Definition at line 11 of file macroutils.py.
| list macro::macroutils::distro_names_indexed = ['diamondback', 'electric', 'unstable'] |
Definition at line 12 of file macroutils.py.
| string macro::macroutils::doc_path = '/var/www/www.ros.org/html/doc/' |
Definition at line 17 of file macroutils.py.
| string macro::macroutils::doc_url = "http://ros.org/doc/" |
Definition at line 15 of file macroutils.py.
