Add ghpages script

This commit is contained in:
Konstantin Lampalzer 2021-01-16 01:32:48 +01:00
parent 0150070b02
commit aa33dc36d8
No known key found for this signature in database
GPG key ID: 9A60A522835A2AD9
8 changed files with 63 additions and 2 deletions

2
.gitignore vendored
View file

@ -128,8 +128,6 @@ dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/

7
.idea/vcs.xml generated Normal file
View 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>

View file

@ -0,0 +1,7 @@
.. _lib_battery:
Battery
=======
.. autoclass:: compLIB.Battery.Battery
:members:

View file

@ -0,0 +1,7 @@
.. _lib_buzzer:
Buzzer
=======
.. autoclass:: compLIB.Buzzer.Buzzer
:members:

View file

@ -0,0 +1,7 @@
.. _lib_irsensor:
Infrared Sensor
================
.. autoclass:: compLIB.IRSensor.IRSensor
:members:

View file

@ -0,0 +1,7 @@
.. _lib_motor:
Motor
=====
.. autoclass:: compLIB.Motor.Motor
:members:

View file

@ -0,0 +1,7 @@
.. _lib_servo:
Servo
=====
.. autoclass:: compLIB.Servo.Servo
:members:

21
sphinx_to_github.sh Executable file
View 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 ..