niklas/tracetools_analysis
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'add-api-docs-link-to-readme' into 'master'

Browse source 
Add API docs link to readme

See merge request micro-ROS/ros_tracing/tracetools_analysis!68
This commit is contained in:
Christophe Bedard 2020-05-24 21:34:07 +00:00
commit 37d56ba279
2 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -63,3 +63,15 @@ time_per_thread = cpu_util.get_time_per_thread()
## Design ## Design
See the [`ros2_tracing` design document](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md), especially the [*Goals and requirements*](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md#goals-and-requirements) and [*Analysis*](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md#analysis) sections. See the [`ros2_tracing` design document](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md), especially the [*Goals and requirements*](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md#goals-and-requirements) and [*Analysis*](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md#analysis) sections.
## Packages
### ros2trace_analysis
Package containing a `ros2cli` extension to perform trace analysis.
### tracetools_analysis
Package containing tools for analyzing trace data.
See the [API documentation](https://micro-ros.gitlab.io/ros_tracing/tracetools_analysis-api/).

2
tracetools_analysis/docs/source/conf.py
View file

@ -34,7 +34,7 @@ sys.path.insert(0, os.path.abspath('../../'))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'tracetools_test' project = 'tracetools_analysis'
copyright = '2019-2020, Robert Bosch GmbH & Christophe Bedard' # noqa copyright = '2019-2020, Robert Bosch GmbH & Christophe Bedard' # noqa
author = 'Robert Bosch GmbH, Christophe Bedard' author = 'Robert Bosch GmbH, Christophe Bedard'