Skip to content

Commit

Permalink
Add logo, structure API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan4253 committed Nov 12, 2023
1 parent 6394786 commit 46cfc2b
Show file tree
Hide file tree
Showing 12 changed files with 113 additions and 14 deletions.
23 changes: 14 additions & 9 deletions docs/api/api.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
### C++ API

[AdaptivePurePursuitController](@ref rz::AdaptivePurePursuitController)

[test](@ref md_docs_tutorials_setup_setup)

[rz Namespace](@ref rz)

[okapi::literal Namespace](@ref okapi::literals)
# C++ API

View all the APIs here:
- [Chassis API](@ref md_docs_api_chassis)
- [Control API](@ref md_docs_api_control)
- [Filter API](@ref md_docs_api_filter)
- [Geometry API](@ref md_docs_api_geometry)
- [Pathing API](@ref md_docs_api_pathing)
- [Trajectory API](@ref md_docs_api_trajectory)
- [Units API](@ref md_docs_api_units)
- [Utility API](@ref md_docs_api_utility)

View the full namespace here:
- [rz Namespace](@ref rz)
4 changes: 4 additions & 0 deletions docs/api/chassis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Chassis API

This API includes all the motion control algorithms that can be used for your robot's chassis in autonomous mode. They are all async, meaning they can be run concurrently with other parts of your robot. Make sure to not have two motion controllers control the chassis at the same time.
- [AdaptivePurePursuitController](@ref rz::AdaptivePurePursuitController)
20 changes: 20 additions & 0 deletions docs/api/control.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Control API
explanation
<br>
<br>

### Iterative Control API
explanation
- [IterativeVelBangBangController](@ref rz::IterativeVelBangBangController)
- [IterativeVelTBHController](@ref rz::IterativeVelTBHController)

### Async Control API
explanation
- [AsyncVelBangBangController](@ref rz::AsyncVelBangBangController)
- [AsyncVelTBHController](@ref rz::AsyncVelTBHController)

### Feedforward Control API
explanation
- [FeedforwardController](@ref rz::FeedforwardController)
- [SimpleMotorFeedforward](@ref rz::SimpleMotorFeedforward)

4 changes: 4 additions & 0 deletions docs/api/filter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Filter API

explanation here
- [SlewRate](@ref rz::SlewRate)
19 changes: 19 additions & 0 deletions docs/api/geometry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Geometry API
explanation
<br>
<br>

### Positioning API
explanation
- [Rotation](@ref rz::Rotation)
- [Translation](@ref rz::Translation)
- [Pose](@ref rz::Pose)
- [Transform](@ref rz::Transform)
- [Twist](@ref rz::Twist)

### Coordinate System API
explanation
- [CoordinateAxis](@ref rz::CoordinateAxis)
- [CoordinateRotation](@ref rz::CoordinateRotation)
- [CoordinateSystem](@ref rz::CoordinateSystem)

4 changes: 4 additions & 0 deletions docs/api/pathing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Pathing API
explanation
- [DiscretePath](@ref rz::DiscretePath)
- [ParametricPath](@ref rz::ParametricPath)
13 changes: 13 additions & 0 deletions docs/api/trajectory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Trajectory API
explanation
<br>
<br>

### Trajectory API
explanation
- Nonexistent Trajectory Class

### Motion Profile API
explanation
- [MotionProfile](@ref rz::MotionProfile)
- [TrapezoidalMotionProfile](@ref rz::TrapezoidalMotionProfile)
4 changes: 4 additions & 0 deletions docs/api/units.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Units API
explanation (link to tutorial)

- [Units](@ref okapi)
14 changes: 14 additions & 0 deletions docs/api/utility.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Utility API
explanation
<br>
<br>

### Multithreading API
explanation
- [CrossPlatformThread](@ref rz::CrossPlatformThread)
- [CrossPlatformMutex](@ref rz::CrossPlatformMutex)

### Misc API
explanation
- [Math](@ref rz)
- [Utility](@ref rz)
19 changes: 14 additions & 5 deletions docs/doxygen/conf.py
Original file line number Diff line number Diff line change
@@ -1,20 +1,29 @@
DOXYFILE = 'Doxyfile-mcss'

FAVICON = '../images/raid_zero.png'

LINKS_NAVBAR1 = [
('Get started', 'md_docs_tutorials_setup_setup', []),
('Get Started', 'md_docs_tutorials_setup_setup', []),
('Examples', 'md_docs_tutorials_examples_examples', [])
]

LINKS_NAVBAR2 = [
('Classes', 'annotated', []),
('C++ API', 'md_docs_api_api', [
('Pages', 'pages'),
('Setup Guide', 'md_docs_tutorials_setup_setup'),
('Namespace', 'namespaceokapi'),
('Chassis API', 'md_docs_api_chassis'),
('Control API', 'md_docs_api_control'),
('Filter API', 'md_docs_api_filter'),
('Geometry API', 'md_docs_api_geometry'),
('Pathing API', 'md_docs_api_pathing'),
('Trajectory API', 'md_docs_api_trajectory'),
('Units API', 'md_docs_api_units'),
('Utility API', 'md_docs_api_utility'),
('Namespace', 'namespacerz')
])
]

STYLESHEETS = [
'./m.css/css/m-dark+documentation.compiled.css',
'https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600'
'https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600',
'docs.css'
]
3 changes: 3 additions & 0 deletions docs/doxygen/docs.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
main p {
text-indent: 0rem;
}
Binary file added docs/images/raid_zero.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 46cfc2b

Please sign in to comment.