From 7e1b6a1489d4545b0dbe3d9fe92a0aa9943e8247 Mon Sep 17 00:00:00 2001 From: "Bryan W. Weber" Date: Fri, 20 Jul 2018 20:01:10 -0400 Subject: [PATCH] [Doc/CI] Build the docs after testing and upload to cantera.org Use an ssh key with write access to cantera.org to rsync the built docs. Only runs on non-pull-request builds of the master branch. The sphinxcontrib-doxylink and sphinxcontrib-katex packages have bugs that are fixed in our forks, so we have to install from the forks. --- .gitignore | 1 + .travis.yml | 36 ++++++++++++++++++++++++++++++++++++ doc/ctdeploy_key.enc | Bin 0 -> 1696 bytes 3 files changed, 37 insertions(+) create mode 100644 doc/ctdeploy_key.enc diff --git a/.gitignore b/.gitignore index 73fb87e95..529981cb8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +doc/ctdeploy_key *~ *.o *.so diff --git a/.travis.yml b/.travis.yml index facb771b7..4ea66bf65 100644 --- a/.travis.yml +++ b/.travis.yml @@ -18,6 +18,16 @@ addons: - liblapack-dev - libblas-dev - libboost-dev + - doxygen + - graphviz + ssh_known_hosts: + - cantera.org + +env: + global: + secure: "IqQ4IVKzZbMCIVrD6t3YQDi3mEiswhTWo3AAKg2CrA+CETads/I9d0g68krKCA2xue0zm9pFVWbs5MT2F6Yq2PNsdvoN3ZMHrpXTN2ZJ7pgukgVwNuBe7B/tm6xBzSbZ4KPIanWCu3TNXsZp9EPG1rdhagAZZ+TeDYdIUKAITjYOVIiiAsqiLllsE9cAq3jkiu/JAxB0tzicxERi1RtnMfL/1d9fupP+yrExwIYo+hhAwWwghdiKzh551sowpbVFVxuOtTJfpC+vh1a/kLo/VTr4DDe6Bdkubc7beU8WZiZNVVbNoydy/qYkKuOzmXu9Llo9flMzJKswR7Szxi8nhD2zc+3pOYxJilWPYtrG4WrJr3WFTU3xZg5KsLwNpCane1uAsrj/NNtMagp+Wj1yOBMDMmHF5GAyCVEgSqY2PLISaEPOPCJV4VihaHyie1hM/A5YlD2VwkkKJTjMIP2VpaLVo9Sr3jXUIhtp/wLNleSWENX7etFjVqhwX1ldhz6+gVrn/H6oS2LwHQwlAseE9O6eqAB5ia+9duYDt7JS5F1P8QMYhz1gaJGXKWBnCEur5XHoGhZ75nyNnpmLjDOHKk5NmQQNL6ltUqg3fX7EWOjzxHlymdZ/4lg5AESj/+nBAhJJcAYRn9hHti7JLMjF6Qk/Kf3pJ6qVBHETY2KivH8=" + + before_script: | echo TRAVIS_OS_NAME: $TRAVIS_OS_NAME if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then @@ -31,12 +41,38 @@ before_script: | else pip2 install --user --install-option="--no-cython-compile" cython pip2 install --user 3to2 + + # Install packages for the documentation + pip2 install --user sphinx sphinxcontrib-matlabdomain + # These two packages have specific bug fixes from these branches + pip2 install --user https://github.com/Cantera/doxylink/archive/fix_relative_path_source_14.tar.gz + pip2 install --user https://github.com/bryanwweber/sphinxcontrib-katex/archive/fix-options-bug.tar.gz fi rm -f cantera.conf script: | if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then + set -e scons build -j2 VERBOSE=y python2_package=full python3_package=full python3_cmd=/usr/bin/python3 blas_lapack_libs=lapack,blas optimize=n coverage=y scons test + scons build sphinx_docs=y doxygen_docs=y + if [[ "${TRAVIS_PULL_REQUEST}" == "false" ]] && [[ "${TRAVIS_BRANCH}" == "master" ]]; then + openssl aes-256-cbc -k "${ctdeploy_pass}" -in ./doc/ctdeploy_key.enc -out ./doc/ctdeploy_key -d + chmod 0600 ./doc/ctdeploy_key + RSYNC_OPTIONS=( + -avzP + --checksum + --rsh='ssh -i ./doc/ctdeploy_key' + --exclude='*.map' + --exclude='*.md5' + --delete + --delete-excluded + ) + RSYNC_USER="ctdeploy" + RSYNC_SERVER="cantera.org" + RSYNC_DEST="testing.cantera.org/documentation/dev" + DOCS_OUTPUT_DIR="./build/docs/" + rsync "${RSYNC_OPTIONS[@]}" "${DOCS_OUTPUT_DIR}" ${RSYNC_USER}@${RSYNC_SERVER}:${RSYNC_DEST} + fi else python3 `which scons` build -j2 VERBOSE=y python2_package=full python3_package=full python2_cmd=/usr/local/opt/python@2/bin/python2 blas_lapack_libs=lapack,blas optimize=n coverage=y python3 `which scons` test diff --git a/doc/ctdeploy_key.enc b/doc/ctdeploy_key.enc new file mode 100644 index 0000000000000000000000000000000000000000..567f9eb43b900414b6fe63bd9006046f7dd9f481 GIT binary patch literal 1696 zcmV;R24DG8VQh3|WM5x_Y}m5S!jc}RPFJ6o5x203&oy3szU2cW!zN70wJzE2z4pYp z{4d7PrTG0HW?^6}HSoQI)HU1otN8CEE}^Zl+&PKcU*<175vhbj7wv1;N4zkne-*$# zI(n3+a9--_PNEe}uj+0-&>og#JVdZ_7uWeWfqyc1=+ey{sH51Lyq?OQnBqpb^RFeD zEHp%;u_Dhk_FFBM3kJ99q3!-dqB(=fAYfq14{>&av>+~F5cqpa6%@8E33N~8$7Q_~ z6*j9Ss7+W!eQTiW916Mt1xoQK(^R!qysO{N@Tg<4Y%;QAO>PqQwS1-l(n5s+T;x*h zrG(EvHMjxgBH7yFW(#qlyb0R$^~wve5iKmn74Cmgop>1%Gc&^jaV$g~sY?OR@`*1` zU-+*jzw1Vj#w6SeeCA?5GLuynJ0-x2Z^^i5b=8LRNZ*>obYNntOLB%;e1Wa^y&GmW z`R0cxK%QNr!x{5mh8lO6{py?J{*{r;OvR$}%HC$kllr+Nj?=D8SWm%Fr~260Rxxlr zKpr`d<|RY^-;+h@xi#aG6ldllZ=a@0t21x6FLa2AI4F1jL=bJ zjbepVq^we`75{ z6z~qgNanaVwF+q%k>8S; z*}ZPz=!6?q9zz*tV~u<1PwK6>XFECd*scex9IbmGq4<`dbS#s>8*Y3S+C#yj4-%ZG z-dy8lQDis~c7xsyH)0(;)i!HnBdbS+P}t#bM>cwtduNp^2Q}>yrJFl%?b7XGej(W* z$v$Oqbd?PYX!ws>lit884j7E2#b7Gi zQ4sa-dl^qyt3>Qo#=}ld-_u7X6wLd=doG6nEKCeD$Ftw$hTBCn>N8;O1r{Pq`G-Tg zF|9KrsgOUXajSc=OYvisn9zo&;1Q@a{M7+lgau;XPZewt2n}t~4RBOmmcg|9_%_zJ z)qloR!N`dVp|Jef_{%5N#1>KX(ILL*$t=8XNCLtaXKyKCv%3Ow5smPip=kbPFu0xj znPC_MsF&YjP7EW3vh5Bp*jJ$$}tP{NwpPXRo)WAwFfmIS{6>amcRO-wZ(uSUh zIuRzN>wzFeWYrW0hM*W-OHtt&H*KcE7vu{KeLPzdrhiBtnw$2{miD~VQ^x}5k+V+I9+$m*qNJ{-dgkZbnIiJP*jWyS|6_7?VRnGY%fWZ~K~B z{TbLHQ%J<}y}6NES_k_S4EmNvjsQOnropUoqA={Va&#hzVJ%nUQ-xjK->A4aUA42P zWlYG<02J9VCnwxGJHhnndtCoB%SMV={|lL^Xtb6Oh2V=8L#tFi@LlQwiQxg*NXdpu zwcP#!QW+JkR!sqD91H}NHT^1DwWvdk8cmAloDZ$gt3_*1A6C<~n(HLJ@2!1n2LoV} zvLV3a4iG{*v?$pcbc@|Im|KCW%AQ>q^^>Z!30YD?EN{h+OZ0gwb_}KoGIYNR5?x?9 z8OyEUXdjvnfb~0Y%YahQa!fFazguKKz-2q+6ac4aln<=gQjdOSb+7mOqxW! literal 0 HcmV?d00001