From c9b0ae4229bf0362b2a9782816347e409123c946 Mon Sep 17 00:00:00 2001 From: Robert Wolterman Date: Tue, 4 Jul 2017 12:05:03 -0500 Subject: [PATCH] moving the docs to separate files as it will be easier to maintain --- docs/gpio.md | 20 ++++++++ docs/index.md | 123 +++------------------------------------------- docs/lradc.md | 20 ++++++++ docs/pwm.md | 22 +++++++++ docs/servo.md | 20 ++++++++ docs/softpwm.md | 20 ++++++++ docs/utilities.md | 20 ++++++++ 7 files changed, 129 insertions(+), 116 deletions(-) create mode 100644 docs/gpio.md create mode 100644 docs/lradc.md create mode 100644 docs/pwm.md create mode 100644 docs/servo.md create mode 100644 docs/softpwm.md create mode 100644 docs/utilities.md diff --git a/docs/gpio.md b/docs/gpio.md new file mode 100644 index 0000000..d9fa913 --- /dev/null +++ b/docs/gpio.md @@ -0,0 +1,20 @@ +## CHIP_IO.GPIO +Import the GPIO module as follows + + ```python + import CHIP_IO.GPIO as GPIO + ``` + +### toggle_debug() +Enable/Disable the Debug + +* Parameters + None + +* Examples + + ```python + GPIO.toggle_debug() + ``` + +[home](./index.md) diff --git a/docs/index.md b/docs/index.md index 9f59117..62f013c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,117 +1,8 @@ -## CHIP_IO.GPIO -Import the GPIO module as follows - - ```python - import CHIP_IO.GPIO as GPIO - ``` - -### toggle_debug() -Enable/Disable the Debug - -* Parameters - None - -* Examples - - ```python - GPIO.toggle_debug() - ``` - -## CHIP_IO.PWM -Import the PWM module as follows - - ```python - import CHIP_IO.PWM as PWM - ``` - -### toggle_debug() -Enable/Disable the Debug - -* Parameters - None - -* Examples - - ```python - PWM.toggle_debug() - ``` - - -## CHIP_IO.SOFTPWM -Import the SOFTPWM module as follows - - ```python - import CHIP_IO.SOFTPWM as SPWM - ``` - -### toggle_debug() -Enable/Disable the Debug - -* Parameters - None - -* Examples - - ```python - SPWM.toggle_debug() - ``` - - -## CHIP_IO.SERVO -Import the SERVO module as follows - - ```python - import CHIP_IO.SERVO as SERVO - ``` - -### toggle_debug() -Enable/Disable the Debug - -* Parameters - None - -* Examples - - ```python - SERVO.toggle_debug() - ``` - - -## CHIP_IO.LRADC -Import the LRADC module as follows - - ```python - import CHIP_IO.LRADC as LRADC - ``` - -### toggle_debug() -Enable/Disable the Debug - -* Parameters - None - -* Examples - - ```python - LRADC.toggle_debug() - ``` - -## CHIP_IO.Utilities -Import the Utilities module as follows - - ```python - import CHIP_IO.Utilities as UT - ``` - -### toggle_debug() -Enable/Disable the Debug - -* Parameters - None - -* Examples - - ```python - UT.toggle_debug() - ``` +## CHIP_IO API Documentation +* [CHIP_IO.GPIO](./gpio.md) +* [CHIP_IO.PWM](./pwm.md) +* [CHIP_IO.SOFTPWM](./softpwm.md) +* [CHIP_IO.SERVO](./servo.md) +* [CHIP_IO.LRADC](./lradc.md) +* [CHIP_IO.Utilities](./utilities.md) diff --git a/docs/lradc.md b/docs/lradc.md new file mode 100644 index 0000000..bab4d33 --- /dev/null +++ b/docs/lradc.md @@ -0,0 +1,20 @@ +## CHIP_IO.LRADC +Import the LRADC module as follows + + ```python + import CHIP_IO.LRADC as LRADC + ``` + +### toggle_debug() +Enable/Disable the Debug + +* Parameters + None + +* Examples + + ```python + LRADC.toggle_debug() + ``` + +[home](./index.md) diff --git a/docs/pwm.md b/docs/pwm.md new file mode 100644 index 0000000..26a54a7 --- /dev/null +++ b/docs/pwm.md @@ -0,0 +1,22 @@ +## CHIP_IO.PWM +Import the PWM module as follows + + ```python + import CHIP_IO.PWM as PWM + ``` + +### toggle_debug() +Enable/Disable the Debug + +* Parameters + None + +* Examples + + ```python + PWM.toggle_debug() + ``` + + + +[home](./index.md) diff --git a/docs/servo.md b/docs/servo.md new file mode 100644 index 0000000..2d2e81c --- /dev/null +++ b/docs/servo.md @@ -0,0 +1,20 @@ +## CHIP_IO.SERVO +Import the SERVO module as follows + + ```python + import CHIP_IO.SERVO as SERVO + ``` + +### toggle_debug() +Enable/Disable the Debug + +* Parameters + None + +* Examples + + ```python + SERVO.toggle_debug() + ``` + +[home](./index.md) diff --git a/docs/softpwm.md b/docs/softpwm.md new file mode 100644 index 0000000..66fe8f5 --- /dev/null +++ b/docs/softpwm.md @@ -0,0 +1,20 @@ +## CHIP_IO.SOFTPWM +Import the SOFTPWM module as follows + + ```python + import CHIP_IO.SOFTPWM as SPWM + ``` + +### toggle_debug() +Enable/Disable the Debug + +* Parameters + None + +* Examples + + ```python + SPWM.toggle_debug() + ``` + +[home](./index.md) diff --git a/docs/utilities.md b/docs/utilities.md new file mode 100644 index 0000000..4296215 --- /dev/null +++ b/docs/utilities.md @@ -0,0 +1,20 @@ +## CHIP_IO.Utilities +Import the Utilities module as follows + + ```python + import CHIP_IO.Utilities as UT + ``` + +### toggle_debug() +Enable/Disable the Debug + +* Parameters + None + +* Examples + + ```python + UT.toggle_debug() + ``` + +[home](./index.md)