Skip to content

Commit

Permalink
organize docs (nasa#449)
Browse files Browse the repository at this point in the history
  • Loading branch information
trey0 authored Mar 22, 2022
1 parent e16cb95 commit eb787d5
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 8 deletions.
2 changes: 1 addition & 1 deletion astrobee.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -605,7 +605,7 @@ STRICT_PROTO_MATCHING = NO
# list. This list is created by putting \todo commands in the documentation.
# The default value is: YES.

GENERATE_TODOLIST = YES
GENERATE_TODOLIST = NO

# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
# list. This list is created by putting \test commands in the documentation.
Expand Down
4 changes: 3 additions & 1 deletion doc/general_documentation/astrobee_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,6 @@

\subpage adding_a_command

\subpage command_dictionary
\subpage using_telemetry

\subpage maintaining_telemetry
2 changes: 1 addition & 1 deletion doc/general_documentation/maintaining_telemetry.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Maintaining Astrobee Telemetry Backward Compatibility
\page maintaining_telemetry Maintaining Astrobee Telemetry Backward Compatibility

## Motivation and scope

Expand Down
4 changes: 1 addition & 3 deletions doc/general_documentation/public_data.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
\page using_telemetry

# Using Astrobee Robot Telemetry Logs
\page using_telemetry Using Astrobee Robot Telemetry Logs

The ISS Astrobee Facility has established an [Astrobee ISS telemetry
log public release
Expand Down
3 changes: 3 additions & 0 deletions doc/general_documentation/subsystems.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ Definition of topic names are maintained in \subpage shared:<br>
- Bridge
- Msg / Srv / Action

### Description (URDF Robot Description)
- \subpage urdf

### Drivers (hardware)
- \subpage hw
- directory: `hardware`
Expand Down
2 changes: 1 addition & 1 deletion tools/bag_processing/readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
\page bagprocessing Bag Processing
\page bag_processing Bag Processing

# Package Overview
The bag processing package provides several helper tools for handling bagfiles.
Expand Down
2 changes: 1 addition & 1 deletion tools/imu_bias_tester/readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
\page imubiastester Imu Bias Tester
\page imubiastester IMU Bias Tester

## ImuBiasTester
The ImuBiasTester integrates IMU measurements using the latest estimated IMU biases from graph_state messages.
Expand Down

0 comments on commit eb787d5

Please sign in to comment.