Add ghpages script
This commit is contained in:
parent
0150070b02
commit
aa33dc36d8
8 changed files with 63 additions and 2 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -128,8 +128,6 @@ dist/
|
||||||
downloads/
|
downloads/
|
||||||
eggs/
|
eggs/
|
||||||
.eggs/
|
.eggs/
|
||||||
lib/
|
|
||||||
lib64/
|
|
||||||
parts/
|
parts/
|
||||||
sdist/
|
sdist/
|
||||||
var/
|
var/
|
||||||
|
|
7
.idea/vcs.xml
generated
Normal file
7
.idea/vcs.xml
generated
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="VcsDirectoryMappings">
|
||||||
|
<mapping directory="$PROJECT_DIR$" vcs="Git" />
|
||||||
|
<mapping directory="$PROJECT_DIR$/docs/gh-pages" vcs="Git" />
|
||||||
|
</component>
|
||||||
|
</project>
|
7
docs/source/lib/Battery.rst
Normal file
7
docs/source/lib/Battery.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
.. _lib_battery:
|
||||||
|
|
||||||
|
Battery
|
||||||
|
=======
|
||||||
|
|
||||||
|
.. autoclass:: compLIB.Battery.Battery
|
||||||
|
:members:
|
7
docs/source/lib/Buzzer.rst
Normal file
7
docs/source/lib/Buzzer.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
.. _lib_buzzer:
|
||||||
|
|
||||||
|
Buzzer
|
||||||
|
=======
|
||||||
|
|
||||||
|
.. autoclass:: compLIB.Buzzer.Buzzer
|
||||||
|
:members:
|
7
docs/source/lib/IRSensor.rst
Normal file
7
docs/source/lib/IRSensor.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
.. _lib_irsensor:
|
||||||
|
|
||||||
|
Infrared Sensor
|
||||||
|
================
|
||||||
|
|
||||||
|
.. autoclass:: compLIB.IRSensor.IRSensor
|
||||||
|
:members:
|
7
docs/source/lib/Motor.rst
Normal file
7
docs/source/lib/Motor.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
.. _lib_motor:
|
||||||
|
|
||||||
|
Motor
|
||||||
|
=====
|
||||||
|
|
||||||
|
.. autoclass:: compLIB.Motor.Motor
|
||||||
|
:members:
|
7
docs/source/lib/Servo.rst
Normal file
7
docs/source/lib/Servo.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
.. _lib_servo:
|
||||||
|
|
||||||
|
Servo
|
||||||
|
=====
|
||||||
|
|
||||||
|
.. autoclass:: compLIB.Servo.Servo
|
||||||
|
:members:
|
21
sphinx_to_github.sh
Executable file
21
sphinx_to_github.sh
Executable file
|
@ -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 ..
|
Reference in a new issue