catkin_pkg documentation

Add your content using reStructuredText syntax. See the reStructuredText documentation for details.

Contents:

• catkin_pkg package
  • Subpackages
    • catkin_pkg.cli package
      • Submodules
      • catkin_pkg.cli.create_pkg module
      • catkin_pkg.cli.find_pkg module
      • catkin_pkg.cli.generate_changelog module
      • catkin_pkg.cli.package_version module
      • catkin_pkg.cli.prepare_release module
      • catkin_pkg.cli.tag_changelog module
      • catkin_pkg.cli.test_changelog module
      • Module contents
  • Submodules
  • catkin_pkg.changelog module
    • BulletList
      • BulletList.as_rst()
      • BulletList.as_txt()
      • BulletList.bullet_generator()
    • Changelog
      • Changelog.add_version_section()
      • Changelog.foreach_version()
      • Changelog.get_content_of_version()
      • Changelog.get_date_of_version()
      • Changelog.package_name
      • Changelog.rst
    • DuplicateVersionsException
    • InvalidSectionTitle
    • MixedText
      • MixedText.to_txt()
    • Reference
      • Reference.as_rst()
      • Reference.as_txt()
    • Transition
    • bullet_list_class_from_docutils()
    • get_changelog_from_path()
    • mixed_text_from_docutils()
    • populate_changelog_from_rst()
    • processes_changelog_children()
    • reference_from_docutils()
    • version_and_date_from_title()
  • catkin_pkg.changelog_generator module
    • escape_trailing_underscores()
    • filter_package_changes()
    • generate_changelog_file()
    • generate_changelogs()
    • generate_package_headline()
    • generate_version_block()
    • generate_version_content()
    • generate_version_headline()
    • get_all_changes()
    • get_forthcoming_changes()
    • get_version_headline()
    • get_version_section_match()
    • get_version_section_pattern()
    • prepend_version_content()
    • replace_repository_references()
    • sorted_tags()
    • update_changelog_file()
    • update_changelogs()
    • version_from_tag()
  • catkin_pkg.changelog_generator_vcs module
    • GitClient
      • GitClient.get_latest_tag_name()
      • GitClient.get_log_entries()
      • GitClient.get_tags()
      • GitClient.replace_repository_references()
      • GitClient.type
    • HgClient
      • HgClient.get_latest_tag_name()
      • HgClient.get_log_entries()
      • HgClient.get_tags()
      • HgClient.type
    • LogEntry
      • LogEntry.affects_path()
    • Tag
    • VcsClientBase
      • VcsClientBase.get_latest_tag_name()
      • VcsClientBase.get_log_entries()
      • VcsClientBase.get_tags()
      • VcsClientBase.replace_repository_references()
    • get_vcs_client()
  • catkin_pkg.cmake module
    • configure_file()
    • configure_string()
    • get_metapackage_cmake_template_path()
  • catkin_pkg.condition module
    • evaluate_condition()
  • catkin_pkg.group_dependency module
    • GroupDependency
      • GroupDependency.condition
      • GroupDependency.evaluate_condition()
      • GroupDependency.evaluated_condition
      • GroupDependency.extract_group_members()
      • GroupDependency.members
      • GroupDependency.name
  • catkin_pkg.group_membership module
    • GroupMembership
      • GroupMembership.condition
      • GroupMembership.evaluate_condition()
      • GroupMembership.evaluated_condition
      • GroupMembership.name
  • catkin_pkg.metapackage module
    • InvalidMetapackage
    • get_cmakelists_txt()
    • get_expected_cmakelists_txt()
    • has_cmakelists_txt()
    • has_valid_cmakelists_txt()
    • validate_metapackage()
  • catkin_pkg.package module
    • Dependency
      • Dependency.condition
      • Dependency.evaluate_condition()
      • Dependency.evaluated_condition
      • Dependency.name
      • Dependency.version_eq
      • Dependency.version_gt
      • Dependency.version_gte
      • Dependency.version_lt
      • Dependency.version_lte
    • Export
      • Export.attributes
      • Export.content
      • Export.evaluate_condition()
      • Export.evaluated_condition
      • Export.tagname
    • InvalidPackage
    • License
    • Package
      • Package.authors
      • Package.build_depends
      • Package.build_export_depends
      • Package.buildtool_depends
      • Package.buildtool_export_depends
      • Package.conflicts
      • Package.description
      • Package.doc_depends
      • Package.evaluate_conditions()
      • Package.exec_depends
      • Package.exports
      • Package.filename
      • Package.get_build_type()
      • Package.get_unconditional_build_types()
      • Package.group_depends
      • Package.has_buildtool_depend_on_catkin()
      • Package.has_invalid_metapackage_dependencies()
      • Package.is_metapackage()
      • Package.licenses
      • Package.maintainers
      • Package.member_of_groups
      • Package.name
      • Package.package_format
      • Package.plaintext_description
      • Package.replaces
      • Package.test_depends
      • Package.urls
      • Package.validate()
      • Package.version
      • Package.version_compatibility
    • Person
      • Person.email
      • Person.name
      • Person.validate()
    • Url
      • Url.type
      • Url.url
    • has_ros_schema_reference()
    • has_ros_schema_reference_string()
    • package_exists_at()
    • parse_package()
    • parse_package_for_distutils()
    • parse_package_string()
  • catkin_pkg.package_templates module
    • CatkinTemplate
      • CatkinTemplate.delimiter
      • CatkinTemplate.escape
      • CatkinTemplate.pattern
    • PackageTemplate
      • PackageTemplate.authors
      • PackageTemplate.build_depends
      • PackageTemplate.build_export_depends
      • PackageTemplate.buildtool_depends
      • PackageTemplate.buildtool_export_depends
      • PackageTemplate.conflicts
      • PackageTemplate.description
      • PackageTemplate.doc_depends
      • PackageTemplate.exec_depends
      • PackageTemplate.exports
      • PackageTemplate.filename
      • PackageTemplate.group_depends
      • PackageTemplate.licenses
      • PackageTemplate.maintainers
      • PackageTemplate.member_of_groups
      • PackageTemplate.name
      • PackageTemplate.package_format
      • PackageTemplate.plaintext_description
      • PackageTemplate.replaces
      • PackageTemplate.test_depends
      • PackageTemplate.urls
      • PackageTemplate.version
      • PackageTemplate.version_compatibility
    • create_cmakelists()
    • create_package_files()
    • create_package_xml()
    • read_template_file()
  • catkin_pkg.package_version module
    • bump_version()
    • get_forthcoming_label()
    • rename_section()
    • update_changelog_sections()
    • update_versions()
  • catkin_pkg.packages module
    • find_package_paths()
    • find_packages()
    • find_packages_allowing_duplicates()
    • verify_equal_package_versions()
  • catkin_pkg.python_setup module
    • generate_distutils_setup()
    • get_global_bin_destination()
    • get_global_etc_destination()
    • get_global_include_destination()
    • get_global_lib_destination()
    • get_global_libexec_destination()
    • get_global_python_destination()
    • get_global_share_destination()
    • get_package_bin_destination()
    • get_package_etc_destination()
    • get_package_include_destination()
    • get_package_lib_destination()
    • get_package_python_destination()
    • get_package_share_destination()
  • catkin_pkg.rospack module
    • reorder_paths()
  • catkin_pkg.terminal_color module
    • ColorTemplate
      • ColorTemplate.delimiter
      • ColorTemplate.pattern
    • ansi()
    • disable_ANSI_colors()
    • enable_ANSI_colors()
    • fmt()
    • sanitize()
  • catkin_pkg.tool_detection module
    • get_previous_tool_used_on_the_space()
    • mark_space_as_built_by()
  • catkin_pkg.topological_order module
    • topological_order()
    • topological_order_packages()
  • catkin_pkg.workspace_vcs module
    • get_repository_type()
    • vcs_remotes()
  • catkin_pkg.workspaces module
    • ensure_workspace_marker()
    • get_spaces()
    • order_paths()
  • Module contents