Deployed 50421c6 to 3.1 with MkDocs 1.6.0 and mike 2.1.1

3.1/api/_sources/index.rst.txt

@@ -0,0 +1,29 @@
+libhal API documentation
+=========================
+
+.. image:: _static/logo.png
+  :width: 200
+  :align: center
+  :alt: libhal logo
+
+**Welcome to libhal API documentation**
+
+Here you will find an organized list of the interfaces used in libhal. 
+This includes soft drivers which are drivers that are not tied to specific hardware. 
+This will also include utility functions.
+
+
+
+.. toctree::
+  :caption: libhal Docs
+  :maxdepth: 5
+
+  Libhal Interfaces <libhal/index>
+  Soft Drivers <soft/index>
+  Utilities <utilities/index>
+
+
+
+
+
+

3.1/api/_sources/libhal/accelerometer.md.txt

@@ -0,0 +1,9 @@
+# Accelerometer
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/accelerometer.hpp>*
+
+```{doxygenclass} hal::accelerometer
+```

3.1/api/_sources/libhal/adc.md.txt

@@ -0,0 +1,10 @@
+# Analog Digital Converter (ADC)
+
+## Hardware Interface
+
+Defined in namespace `hal`
+
+*#include <libhal/adc.hpp>*
+
+```{doxygenclass} hal::adc
+```

3.1/api/_sources/libhal/angular_velocity_sensor.md.txt

@@ -0,0 +1,9 @@
+# Angular Velocity Sensor
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/angular_velocity_sensor.hpp>*
+
+```{doxygenclass} hal::angular_velocity_sensor
+```

3.1/api/_sources/libhal/can.md.txt

@@ -0,0 +1,18 @@
+# Controlled Area Network (CAN)
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/can.hpp>*
+
+```{doxygenclass} hal::can
+```
+
+## Utilities
+
+Utilities for working with CAN, defined in namespace `hal`
+
+*#include <libhal-util/can.hpp>*
+
+```{doxygengroup} CAN_Utilities
+```

3.1/api/_sources/libhal/dac.md.txt

@@ -0,0 +1,9 @@
+# Digital Analog Converter (DAC)
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/dac.hpp>*
+
+```{doxygenclass} hal::dac
+```

3.1/api/_sources/libhal/distance_sensor.md.txt

@@ -0,0 +1,9 @@
+# Distance Sensor
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/distance_sensor.hpp>*
+
+```{doxygenclass} hal::distance_sensor
+```

3.1/api/_sources/libhal/error.md.txt

@@ -0,0 +1,12 @@
+# Error
+
+## Documentation
+Defined in namespace `hal`
+
+*#include <libhal/error.hpp>*
+
+```{doxygengroup} Error
+```
+
+```{doxygennamespace} hal::error
+```

3.1/api/_sources/libhal/functional.md.txt

@@ -0,0 +1,9 @@
+# Functional
+
+## Documentation
+Defined in namespace `hal`
+
+*#include <libhal/functional.hpp>*
+
+```{doxygengroup} Functional
+```

3.1/api/_sources/libhal/gyroscope.md.txt

@@ -0,0 +1,9 @@
+# Gyroscope
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/gyroscope.hpp>*
+
+```{doxygenclass} hal::gyroscope
+```

3.1/api/_sources/libhal/i2c.md.txt

@@ -0,0 +1,15 @@
+# Inter-integrated Circuit (I2C)
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/i2c.hpp>*
+```{doxygenclass} hal::i2c
+```
+
+## Utilities
+Utilities for working with I2C, defined in namespace `hal`
+
+*#include <libhal-util/i2c.hpp>*
+```{doxygengroup} I2CUtils
+```

3.1/api/_sources/libhal/index.rst.txt

@@ -0,0 +1,35 @@
+libhal Hardware Interface API Documentation
+===============================================
+
+Here is the documentation for all of the hardware interfaces libhal has support for along with any accompanying utilities provided by libhal-util.
+Each page is marked with what headers should be included to use each of the APIs.
+
+.. toctree:: 
+    :caption: Interfaces
+    :maxdepth: 2
+
+    accelerometer
+    adc
+    angular_velocity_sensor
+    can
+    dac
+    distance_sensor
+    error
+    functional
+    gyroscope
+    i2c
+    input_pin
+    interrupt_pin
+    magnetometer
+    motor
+    output_pin
+    pwm
+    rotation_sensor
+    serial
+    servo
+    spi
+    steady_clock
+    temperature_sensor
+    timeout
+    timer
+    units

3.1/api/_sources/libhal/input_pin.md.txt

@@ -0,0 +1,17 @@
+# Input Pin
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/input_pin.hpp>*
+
+```{doxygenclass} hal::input_pin
+```
+
+## Utilities
+Defined in namespace `hal`
+
+*#include <libhal-util/input_pin.hpp>*
+
+```{doxygengroup} InputPin
+```

3.1/api/_sources/libhal/interrupt_pin.md.txt

@@ -0,0 +1,17 @@
+# Interrupt Pin
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/interrupt_pin.hpp>*
+
+```{doxygenclass} hal::interrupt_pin
+```
+
+## Utilities
+Defined in namespace `hal`
+
+*#include <libhal-util/interrupt_pin.hpp>*
+
+```{doxygengroup} InterruptPin
+```

3.1/api/_sources/libhal/magnetometer.md.txt

@@ -0,0 +1,10 @@
+# Magnetometer
+
+## Hardware Interface
+
+Defined in namespace `hal`
+
+*#include <libhal/magnetometer.hpp>*
+
+```{doxygenclass} hal::magnetometer
+```

3.1/api/_sources/libhal/motor.md.txt

@@ -0,0 +1,10 @@
+# Motor
+
+## Hardware Interface
+
+Defined in namespace `hal`
+
+*#include <libhal/motor.hpp>*
+
+```{doxygenclass} hal::motor
+```

3.1/api/_sources/libhal/output_pin.md.txt

@@ -0,0 +1,17 @@
+# Output Pin
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/output_pin.hpp>*
+
+```{doxygenclass} hal::output_pin
+```
+
+## Utilities
+Defined in namespace `hal`
+
+*#include <libhal-util/output_pin.hpp>*
+
+```{doxygengroup} OutputPin
+```

3.1/api/_sources/libhal/pwm.md.txt

@@ -0,0 +1,9 @@
+# Pulse Width Modulation (PWM)
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/pwm.hpp>*
+
+```{doxygenclass} hal::pwm
+```

3.1/api/_sources/libhal/rotation_sensor.md.txt

@@ -0,0 +1,9 @@
+# Rotational Sensor
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/rotation_sensor.hpp>*
+
+```{doxygenclass} hal::rotation_sensor
+```

3.1/api/_sources/libhal/serial.md.txt

@@ -0,0 +1,23 @@
+# Serial
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/serial.hpp>*
+
+```{doxygenclass} hal::serial
+```
+
+## Utilities
+Defined in namespace `hal`
+
+*#include <libhal-util/serial.hpp>*
+
+```{doxygengroup} Serial
+```
+
+## Coroutines
+*#include <libhal-util/serial_coroutines.hpp>*
+
+```{doxygengroup} SerialCoroutines
+```

3.1/api/_sources/libhal/servo.md.txt

@@ -0,0 +1,9 @@
+# Servo
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/servo.hpp>*
+
+```{doxygenclass} hal::servo
+```

3.1/api/_sources/libhal/spi.md.txt

@@ -0,0 +1,17 @@
+# Serial Peripheral Interface (SPI)
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/spi.hpp>*
+
+```{doxygenclass} hal::spi
+```
+
+## Utilities
+Defined in namespace `hal`
+
+*#include <libhal-util/spi.hpp>*
+
+```{doxygengroup} SPI
+```

3.1/api/_sources/libhal/steady_clock.md.txt

@@ -0,0 +1,17 @@
+# Steady Clock
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/steady_clock.hpp>*
+
+```{doxygenclass} hal::steady_clock
+```
+
+## Utilities
+Defined in namespace `hal`
+
+*#include <libhal-util/steady_clock.hpp>*
+
+```{doxygengroup} SteadyClock
+```

3.1/api/_sources/libhal/temperature_sensor.md.txt

@@ -0,0 +1,9 @@
+# Temperature Sensor
+
+## Hardware Interface
+Defined in namespace `hal`
+
+*#include <libhal/temperature_sensor.hpp>*
+
+```{doxygenclass} hal::temperature_sensor
+```

3.1/api/_sources/libhal/timeout.md.txt

@@ -0,0 +1,17 @@
+# Timeout
+
+## Core Functionality
+Defined in namespace `hal`
+
+*#include <libhal/timeout.hpp>*
+
+```{doxygengroup} TimeoutCore
+```
+
+## Utilities
+Defined in namespace `hal`
+
+*#include <libhal-util/timeout.hpp>*
+
+```{doxygengroup} TimeoutUtil
+```