From 991c7aa01aa4698af3644de9975ff2715ba88833 Mon Sep 17 00:00:00 2001 From: Kristian Sloth Lauszus Date: Sat, 13 Oct 2018 23:05:46 +0200 Subject: [PATCH] Install GraphViz, make sure Jekyll is disabled and updated the doc README --- .travis.yml | 4 ++++ doc/README.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 025b2f9a..2a46dfc5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -11,6 +11,9 @@ cache: addons: apt: packages: + # We need GraphViz to draw figures and graphs + - graphviz + # Doxygen is used for generating the documentation - doxygen # Generated using: find examples -type f -name "*.ino" | rev | cut -d/ -f2- | rev | sed 's/^/ - PLATFORMIO_CI_SRC=/' > tmp.yml @@ -87,6 +90,7 @@ before_deploy: - sed -i 's/Circuits@/Circuits\\@/' README.md - sed -i 's/@YuuichiAkagawa/\\@YuuichiAkagawa/' README.md - doxygen doc/Doxyfile + - touch doc/html/.nojekyll deploy: provider: pages diff --git a/doc/README.md b/doc/README.md index 2735d223..4726c9bc 100644 --- a/doc/README.md +++ b/doc/README.md @@ -8,4 +8,4 @@ __________ 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: . +The library documentation is generated using [Doxygen](http://www.stack.nl/~dimitri/doxygen/) and can be found at the following link: .