Skip to content
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.

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

docs: create API reference page, link class/namespace/... references in navigation #194

Merged
merged 3 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/api_reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Nebula is divided into several modules:

- Common, for type definitions and utilities
mojomex marked this conversation as resolved.
Show resolved Hide resolved
- Decoders, for converting raw packets into pointclouds and performing correction and filtering
mojomex marked this conversation as resolved.
Show resolved Hide resolved
- HW Interfaces, for hardware protocols and socket implementations
mojomex marked this conversation as resolved.
Show resolved Hide resolved
- ROS Wrappers, for ROS launch, parameter handling, data publishing and diagnostics
mojomex marked this conversation as resolved.
Show resolved Hide resolved

For API details, see the navigation items on this page.
94 changes: 90 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,96 @@ nav:
- Supported sensors: supported_sensors.md
- Tutorials: tutorials.md
- Contributing: contribute.md
- Nebula common: nebula_common/links.md
- Nebula decoders: nebula_decoders/links.md
- Nebula HW interfaces: nebula_hw_interfaces/links.md
- Nebula ROS: nebula_ros/links.md
- API reference:
- api_reference.md
- Nebula common:
- Links: nebula_common/links.md
- Classes:
- Class List: nebula_common/annotated.md
- Class Index: nebula_common/classes.md
- Class Hierarchy: nebula_common/hierarchy.md
- Class Members: nebula_common/class_members.md
- Class Member Functions: nebula_common/class_member_functions.md
- Class Member Variables: nebula_common/class_member_variables.md
- Class Member Typedefs: nebula_common/class_member_typedefs.md
- Class Member Enumerations: nebula_common/class_member_enums.md
- Namespaces:
- Namespace List: nebula_common/namespaces.md
- Namespace Members: nebula_common/namespace_members.md
- Namespace Member Functions: nebula_common/namespace_member_functions.md
- Namespace Member Variables: nebula_common/namespace_member_variables.md
- Namespace Member Typedefs: nebula_common/namespace_member_typedefs.md
- Namespace Member Enumerations: nebula_common/namespace_member_enums.md
- Functions: nebula_common/functions.md
- Variables: nebula_common/variables.md
- Macros: nebula_common/macros.md
- Files: nebula_common/files.md
- Nebula decoders:
- Links: nebula_decoders/links.md
- Classes:
- Class List: nebula_decoders/annotated.md
- Class Index: nebula_decoders/classes.md
- Class Hierarchy: nebula_decoders/hierarchy.md
- Class Members: nebula_decoders/class_members.md
- Class Member Functions: nebula_decoders/class_member_functions.md
- Class Member Variables: nebula_decoders/class_member_variables.md
- Class Member Typedefs: nebula_decoders/class_member_typedefs.md
- Class Member Enumerations: nebula_decoders/class_member_enums.md
- Namespaces:
- Namespace List: nebula_decoders/namespaces.md
- Namespace Members: nebula_decoders/namespace_members.md
- Namespace Member Functions: nebula_decoders/namespace_member_functions.md
- Namespace Member Variables: nebula_decoders/namespace_member_variables.md
- Namespace Member Typedefs: nebula_decoders/namespace_member_typedefs.md
- Namespace Member Enumerations: nebula_decoders/namespace_member_enums.md
- Functions: nebula_decoders/functions.md
- Variables: nebula_decoders/variables.md
- Macros: nebula_decoders/macros.md
- Files: nebula_decoders/files.md
- Nebula HW interfaces:
- Links: nebula_hw_interfaces/links.md
- Classes:
- Class List: nebula_hw_interfaces/annotated.md
- Class Index: nebula_hw_interfaces/classes.md
- Class Hierarchy: nebula_hw_interfaces/hierarchy.md
- Class Members: nebula_hw_interfaces/class_members.md
- Class Member Functions: nebula_hw_interfaces/class_member_functions.md
- Class Member Variables: nebula_hw_interfaces/class_member_variables.md
- Class Member Typedefs: nebula_hw_interfaces/class_member_typedefs.md
- Class Member Enumerations: nebula_hw_interfaces/class_member_enums.md
- Namespaces:
- Namespace List: nebula_hw_interfaces/namespaces.md
- Namespace Members: nebula_hw_interfaces/namespace_members.md
- Namespace Member Functions: nebula_hw_interfaces/namespace_member_functions.md
- Namespace Member Variables: nebula_hw_interfaces/namespace_member_variables.md
- Namespace Member Typedefs: nebula_hw_interfaces/namespace_member_typedefs.md
- Namespace Member Enumerations: nebula_hw_interfaces/namespace_member_enums.md
- Functions: nebula_hw_interfaces/functions.md
- Variables: nebula_hw_interfaces/variables.md
- Macros: nebula_hw_interfaces/macros.md
- Files: nebula_hw_interfaces/files.md
- Nebula ROS:
- Links: nebula_ros/links.md
- Classes:
- Class List: nebula_ros/annotated.md
- Class Index: nebula_ros/classes.md
- Class Hierarchy: nebula_ros/hierarchy.md
- Class Members: nebula_ros/class_members.md
- Class Member Functions: nebula_ros/class_member_functions.md
- Class Member Variables: nebula_ros/class_member_variables.md
- Class Member Typedefs: nebula_ros/class_member_typedefs.md
- Class Member Enumerations: nebula_ros/class_member_enums.md
- Namespaces:
- Namespace List: nebula_ros/namespaces.md
- Namespace Members: nebula_ros/namespace_members.md
- Namespace Member Functions: nebula_ros/namespace_member_functions.md
- Namespace Member Variables: nebula_ros/namespace_member_variables.md
- Namespace Member Typedefs: nebula_ros/namespace_member_typedefs.md
- Namespace Member Enumerations: nebula_ros/namespace_member_enums.md
- Functions: nebula_ros/functions.md
- Variables: nebula_ros/variables.md
- Macros: nebula_ros/macros.md
- Files: nebula_ros/files.md

### Extra Settings ###
plugins:
Expand Down
Loading