Skip to content

docs: rewrite internal sensors section with detailed descriptions and references #1197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: rewrite internal sensors section with detailed descriptions and references #1197

wants to merge 1 commit into from

Conversation

NightzDev
Copy link

This pull request rewrites and enhances the "Internal Sensors for Robots" section in the appendix.

  • Reformatted the content to match the structure and tone of the "External Sensors for Robots" section
  • Added detailed descriptions for each sensor: GNSS, Gyroscope, Accelerometer, Magnetometer, IMU, Pressure Sensor, and Temperature Sensor
  • Unified the content into clear, single-paragraph summaries per sensor
  • Included properly formatted references in reStructuredText (RST) format for consistency with Sphinx and ReadTheDocs

Closes #1162

@AtsushiSakai
Copy link
Owner

@NightzDev Thank you for your PR. Could you please rebase on master branch?

@NightzDev NightzDev force-pushed the enhance-internal-sensor-doc branch 2 times, most recently from 00485e0 to 02c7ec4 Compare May 1, 2025 17:11
AtsushiSakai
AtsushiSakai requested changes May 1, 2025
View reviewed changes
Copy link
Owner

@AtsushiSakai AtsushiSakai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NightzDev Thank you!!. I have one small comment. PTAL.

docs/modules/12_appendix/internal_sensors_main.rst
- *Introduction to Autonomous Mobile Robots*, Roland Siegwart, Illah Nourbakhsh, Davide Scaramuzza
- *Probabilistic Robotics*, Sebastian Thrun, Wolfram Burgard, Dieter Fox
- Wikipedia articles:
- `Inertial Measurement Unit (IMU) <https://en.wikipedia.org/wiki/Inertial_measurement_unit>`_
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe, we need to an empty line here to fix the rendering issue?
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AtsushiSakai AtsushiSakai AtsushiSakai requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

enhance internal sensor doc
2 participants
@NightzDev @AtsushiSakai