index.rst

ament_pep257

Performs a static analysis to check compliance with Python docstring conventions of Python source files using pep257. Files with the following extensions are being considered: .py.

How to run the check from the command line?

The command line tool is provided by the package ament_pep257.

How to run the check from within a CMake ament package as part of the tests?

package.xml:

<buildtool_depend>ament_cmake</buildtool_depend>
<test_depend>ament_cmake_pep257</test_depend>

CMakeLists.txt:

find_package(ament_cmake REQUIRED)
if(BUILD_TESTING)
  find_package(ament_cmake_pep257 REQUIRED)
  ament_pep257()
endif()

When running multiple linters as part of the CMake tests the documentation of the package ament_lint_auto might contain some useful information.

The documentation of the package ament_cmake_test provides more information on testing in CMake ament packages.