Add libhal main API documentation

libhal/4.19.3/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b8468b84418537949432d468dc67bcf4
+tags: 645f666f9bcd5a90fca523b33c5a78b7

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

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

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

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

libhal/4.19.3/_sources/api/allocated_buffer.md.txt

@@ -0,0 +1,10 @@
+# Allocated Buffer
+
+## Documentation
+
+Defined in namespace `hal`
+
+*#include <libhal/allocated_buffer.hpp>*
+
+```{doxygenclass} hal::v5::allocated_buffer
+```

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

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

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

@@ -0,0 +1,10 @@
+# Controlled Area Network (CAN)
+
+## Hardware Interface
+
+Defined in namespace `hal`
+
+*#include <libhal/can.hpp>*
+
+```{doxygenclass} hal::can
+```

libhal/4.19.3/_sources/api/circular_buffer.md.txt

@@ -0,0 +1,10 @@
+# Circular Buffer
+
+## Documentation
+
+Defined in namespace `hal`
+
+*#include <libhal/circular_buffer.hpp>*
+
+```{doxygenclass} hal::v5::circular_buffer
+```

libhal/4.19.3/_sources/api/constants.rst.txt

@@ -0,0 +1,9 @@
+libhal constants, concepts, and units
+===============================================
+
+.. toctree::
+    :caption: Interfaces
+    :maxdepth: 3
+
+    initializers
+    units

libhal/4.19.3/_sources/api/containers.rst.txt

@@ -0,0 +1,14 @@
+libhal Containers
+===================
+
+Here is the documentation for all of the containers used and recommended for libhal and its interfaces.
+
+.. toctree::
+    :caption: Interfaces
+    :maxdepth: 3
+
+    allocated_buffer
+    circular_buffer
+    functional
+    pointers
+    scatter_span

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,10 @@
+# Inter-integrated Circuit (I2C)
+
+## Hardware Interface
+
+Defined in namespace `hal`
+
+*#include <libhal/i2c.hpp>*
+
+```{doxygenclass} hal::i2c
+```

libhal/4.19.3/_sources/api/initializers.md.txt

@@ -0,0 +1,28 @@
+# Initializers
+
+## Documentation
+
+Defined in namespace `hal`
+
+*#include <libhal/initializers.hpp>*
+
+```{doxygenvariable} hal::port
+```
+
+```{doxygenvariable} hal::pin
+```
+
+```{doxygenvariable} hal::bus
+```
+
+```{doxygenvariable} hal::channel
+```
+
+```{doxygenvariable} hal::buffer
+```
+
+```{doxygenstruct} hal::runtime
+```
+
+```{doxygenstruct} hal::unsafe
+```

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

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

libhal/4.19.3/_sources/api/interfaces.rst.txt

@@ -0,0 +1,39 @@
+libhal Hardware Interface API Documentation
+===============================================
+
+Here is the documentation for all of the hardware interfaces libhal has support
+for. Each page is marked with what headers should be included to use each of
+the APIs.
+
+.. toctree::
+    :caption: Interfaces
+    :maxdepth: 3
+
+    accelerometer
+    adc
+    angular_velocity_sensor
+    can
+    dac
+    distance_sensor
+    gyroscope
+    i2c
+    input_pin
+    interrupt_pin
+    io_waiter
+    lock
+    magnetometer
+    motor
+    output_pin
+    pointers
+    pwm
+    rotation_sensor
+    serial
+    servo
+    spi
+    steady_clock
+    stream_dac
+    temperature_sensor
+    timed_interrupt
+    timeout
+    timer
+    usb

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

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

libhal/4.19.3/_sources/api/io_waiter.md.txt

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

libhal/4.19.3/_sources/api/lock.md.txt

@@ -0,0 +1,16 @@
+# Lock
+
+## Hardware Interface
+
+Defined in namespace `hal`
+
+*#include <libhal/lock.hpp>*
+
+```{doxygenclass} hal::basic_lock
+```
+
+```{doxygenclass} hal::pollable_lock
+```
+
+```{doxygenclass} hal::timed_lock
+```

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

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

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

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

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

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

libhal/4.19.3/_sources/api/pointers.md.txt

@@ -0,0 +1,19 @@
+# Pointers
+
+## Documentation
+
+Defined in namespace `hal`
+
+*#include <libhal/pointers.hpp>*
+
+```{doxygenclass} hal::v5::strong_ptr
+```
+
+```{doxygenclass} hal::v5::weak_ptr
+```
+
+```{doxygenclass} hal::v5::optional_ptr
+```
+
+```{doxygenclass} hal::v5::enable_strong_from_this
+```

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

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

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

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

libhal/4.19.3/_sources/api/scatter_span.md.txt

@@ -0,0 +1,12 @@
+# Scatter Span
+
+## Documentation
+
+Defined in namespace `hal`
+
+*#include <libhal/scatter_span.hpp>*
+
+```{doxygennamespace} hal::v5
+   :content-only:
+   :members: scatter_span, make_scatter_array, make_scatter_bytes, make_writable_scatter_bytes
+```

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

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