diff --git a/.gitignore b/.gitignore index 8649d80..d2ec111 100644 --- a/.gitignore +++ b/.gitignore @@ -128,8 +128,6 @@ dist/ downloads/ eggs/ .eggs/ -lib/ -lib64/ parts/ sdist/ var/ diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..be2ec28 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/docs/source/lib/Battery.rst b/docs/source/lib/Battery.rst new file mode 100644 index 0000000..c9505fb --- /dev/null +++ b/docs/source/lib/Battery.rst @@ -0,0 +1,7 @@ +.. _lib_battery: + +Battery +======= + +.. autoclass:: compLIB.Battery.Battery + :members: \ No newline at end of file diff --git a/docs/source/lib/Buzzer.rst b/docs/source/lib/Buzzer.rst new file mode 100644 index 0000000..8a1894a --- /dev/null +++ b/docs/source/lib/Buzzer.rst @@ -0,0 +1,7 @@ +.. _lib_buzzer: + +Buzzer +======= + +.. autoclass:: compLIB.Buzzer.Buzzer + :members: \ No newline at end of file diff --git a/docs/source/lib/IRSensor.rst b/docs/source/lib/IRSensor.rst new file mode 100644 index 0000000..d320c0f --- /dev/null +++ b/docs/source/lib/IRSensor.rst @@ -0,0 +1,7 @@ +.. _lib_irsensor: + +Infrared Sensor +================ + +.. autoclass:: compLIB.IRSensor.IRSensor + :members: \ No newline at end of file diff --git a/docs/source/lib/Motor.rst b/docs/source/lib/Motor.rst new file mode 100644 index 0000000..2d26d06 --- /dev/null +++ b/docs/source/lib/Motor.rst @@ -0,0 +1,7 @@ +.. _lib_motor: + +Motor +===== + +.. autoclass:: compLIB.Motor.Motor + :members: \ No newline at end of file diff --git a/docs/source/lib/Servo.rst b/docs/source/lib/Servo.rst new file mode 100644 index 0000000..eebedc7 --- /dev/null +++ b/docs/source/lib/Servo.rst @@ -0,0 +1,7 @@ +.. _lib_servo: + +Servo +===== + +.. autoclass:: compLIB.Servo.Servo + :members: \ No newline at end of file diff --git a/sphinx_to_github.sh b/sphinx_to_github.sh new file mode 100755 index 0000000..fedfc2a --- /dev/null +++ b/sphinx_to_github.sh @@ -0,0 +1,21 @@ +cd docs +rm -rf build +rm -rf gh-pages + +make html + +git clone git@github.com:F-WuTS/compLIB.git gh-pages + +cd gh-pages +git checkout gh-pages + +cp -r ../build/html/ . + +git add . +git commit -a -m "Update documentation" +git push origin gh-pages + +cd .. +rm -rf gh-pages + +cd .. \ No newline at end of file