Automatically update the documentation when changes are pushed to the master branch

This commit is contained in:
Kristian Sloth Lauszus 2018-10-13 16:37:18 +02:00
parent 211bd717af
commit d41e94db49
4 changed files with 2541 additions and 0 deletions

View file

@ -8,6 +8,11 @@ cache:
directories: directories:
- "~/.platformio" - "~/.platformio"
addons:
apt:
packages:
- doxygen
# Generated using: find examples -type f -name "*.ino" | rev | cut -d/ -f2- | rev | sed 's/^/ - PLATFORMIO_CI_SRC=/' > tmp.yml # Generated using: find examples -type f -name "*.ino" | rev | cut -d/ -f2- | rev | sed 's/^/ - PLATFORMIO_CI_SRC=/' > tmp.yml
env: env:
- PLATFORMIO_CI_SRC=examples/acm/acm_terminal - PLATFORMIO_CI_SRC=examples/acm/acm_terminal
@ -76,3 +81,18 @@ install:
script: script:
- if [[ -z "$SKIP_UNO" ]]; then UNO="--board=uno"; fi - if [[ -z "$SKIP_UNO" ]]; then UNO="--board=uno"; fi
- platformio ci --lib="." $UNO --board=due --board=genuino101 --board=teensy30 --board=teensy31 --board=teensy35 --board=teensy36 --board=teensylc --board=esp12e --board=nodemcu --board=esp32dev - platformio ci --lib="." $UNO --board=due --board=genuino101 --board=teensy30 --board=teensy31 --board=teensy35 --board=teensy36 --board=teensylc --board=esp12e --board=nodemcu --board=esp32dev
before_deploy:
# Fix errors in the Doxygen Markdown parser and generate the docs
- sed -i 's/Circuits@/Circuits\\@/' README.md
- sed -i 's/@YuuichiAkagawa/\\@YuuichiAkagawa/' README.md
- doxygen doc/Doxyfile
deploy:
provider: pages
github-token: $GITHUB_TOKEN
local_dir: doc/html
skip_cleanup: true
keep-history: true
on:
branch: master

2506
doc/Doxyfile Normal file

File diff suppressed because it is too large Load diff

11
doc/README.md Normal file
View file

@ -0,0 +1,11 @@
# USB Host Library Rev.2.0
The code is released under the GNU General Public License.
__________
[![Build Status](https://travis-ci.org/felis/USB_Host_Shield_2.0.svg?branch=master)](https://travis-ci.org/felis/USB_Host_Shield_2.0)
# Documentation
The documenation is automatically build using [Travis](https://travis-ci.com/) and hosted using [Github Pages](https://help.github.com/categories/github-pages-basics/).
The library documentation can be found at the following link: <https://felis.github.io/USB_Host_Shield_2.0/>.

4
doc/imageStyle.css Normal file
View file

@ -0,0 +1,4 @@
.image
{
text-align: left;
}