Use doctr for deploying documentation

TomasTorsvik · Apr 30, 2019 · b60160e · b60160e
1 parent efb7f4b
commit b60160e
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/.travis.yml b/.travis.yml
@@ -2,6 +2,8 @@ language: minimal
 
 env:
   global:
+    # Doctr deploy key for ajdawson/eofs
+    - secure: "ewft/Mb7zDRH7peE5YD6rpgEiIy8NRHaz1lm2EbFPtzJfKV/vXh+WGeapaVpGWemVvfkRCO4nCXngYZWD5cQozTk0SOZL3m5tlm1RxK0KqdcKPS6BXgmWg/oRmDBEducWFTRydAELPU1rh8oN5TAx8K5ErTGxGSjprNfkItbM14="
     - PACKAGES_STANDARD="setuptools numpy pytest pycodestyle"
     - PACKAGES_EXTRA="iris xarray cdms2 genutil"
     - UVCDAT_ANONYMOUS_LOG=no
@@ -39,7 +41,7 @@ install:
     elif [[ $SUITE_TYPE = test_extras ]]; then
       conda install $PACKAGES_STANDARD $PACKAGES_EXTRA;
     else
-      conda install $PACKAGES_STANDARD $PACKAGES_EXTRA;
+      conda install $PACKAGES_STANDARD $PACKAGES_EXTRA sphinx doctr;
     fi
   - python setup.py install
 
@@ -55,8 +57,24 @@ deploy:
     condition: '$SUITE_TYPE == "deploy"'
 
 script:
+  # Fail on error to avoid building documentation when the tests don't pass
   - set -e
+
+  # Run the test suite
   - pytest -vrsx
 
+  # Deploy the documentation. By default doctr only works on the master
+  # branch. We also want to deploy when building a tag, which requires
+  # post-processing to update the "latest" symlink.
+  - if [[ $SUITE_TYPE = "deploy" ]]; then
+      cd doc && make html && cd ..;
+      doctr -V;
+      if [[ -n "$TRAVIS_TAG" ]]; then
+        doctr deploy --build-tags --command './update_links.py && git add latest' "${TRAVIS_TAG%.*}";
+      else
+        doctr deploy dev;
+      fi;
+    fi
+
 notifications:
     email: false
diff --git a/github_deploy_key_ajdawson_eofs.enc b/github_deploy_key_ajdawson_eofs.enc
@@ -0,0 +1 @@
+gAAAAABcsJqAYXk9JKu5xP_9NpHlYuWcYf5RuyU9rZ_xKPvco4cJAkA2H9vk8P6Yl1VFslqGAyWR-v4fTYScJi1LavLXIASOlBN_mh-ElL2wD21LYuaRkiP8ox7Yf9yqkPLxqm_SZcSBnWaM1Ub1qqzteyg6GHNldD8__UqDmjSjYesuN2_i_NcmOLtcrhbfoJbhIK1w0N8agafGLY1Nt5kMIfOtHR8zFJuwgI2Uc5WzTaImYbbhsqWgfe3L5DppZe-_DqMMOXnOUOjjrvQgPD5p10VIj27VIoVA7B8frGSVhABTBEoO3ErkIinkgOlmRDbY_bsxeXpMs4Lg5QHA6y-XQCp-yRMYtesOW8lzvlpVZGCy1Z3NoD7Slx2siUvPW9YE07o0qpp8zLlL26nSboMoXmdA_ua8ABoZ05bPnDyqHCdYSkCAkB_lh5VgkKAEiFiSvEcBw3FVok-sNsDX_tXS5mvPR1WHHxxrqnMQeYEW9JzqhnWkMmtxiEPxOfJSnpo7g8oECFqfsNPHo_3uGPTtQJb2KmRTd3nD4hVPN7vHBshD801pgShnKn6q3XrFggC2QMYQnrZRY9YgzuUrUJK9i1AhTcRsg8ftq2rPjtlArq6DszVwuNn1m2Kee7fV4AHyombO84bpxEkKcoxyQy7CHQ1e3ZMQVbZ_9T95C8a0y2IvSZ93rjQ5uR2xGAdjrLoDyBy_zDlNim62rF4VtcPvUhw2kjQpzMrLxL0cx4CI7iURPbqmFnXCwhkk1MBRBtsLBiJuBjd18ko33U6A_B0SyJQaOzgd-lmP19BBtwT3dssOYWQFsLpr6jXciFy2C6-4Nye27kC2CCwIDCH7l2qwMJhAhe3qbNJoWVVQpwu8RVhnEn-pG5IBIY3vvLVej0M1bGYUfE0wiFgI8gq9kUTQmOc0fP__osYY3bOF8P997izlIs9-RqhoRhdv1hWmvui1i6qk2FrFRIXhMPIroYLqsOyZ_hSyZCBkvGWk0h-WeyXfsCNkOwlwI_40swIH7ZdB2SFx9_n727YoFN4MBbZiXg3vGXC0ci0Gp3LjE36TCkiAAUZr9qcPNjxjYOl0hSlNRlCVnECNpb-d1Qut5LCL8gPzcUYMzTl5jbPaiJL-1NDE-YNE4v9NasvZMwORAphORdyKf7Z07_KAhJDInlWKMaOPPJc8HU49VcKBrIZNG1UCCCZ74ky8bvL1k5Y9Ur3WnWOVofsfnyP7QFUoyV11KZ0ckI8_jNbgSOo89jV5yhk6pKi_pPsYviybMe8VMXFVBDMTf52PbFodSsW_6wEbp2kZ6bIXRuHQANiktefdTFYdM7MjftAeQFJdJJvtSpiVH4EMAKxq8HH2xWq9VroWFR0s_HIPzSeuZxOjwJpY5RhMxY0TbFsFq55tfFKVdScJxG0ZUm0FnvkDME9KHMjEshProHD3lWiv7YkQFpPJ7i_bCFYMjp6CP27Gzjrr1PSTDb7r8jeA17kUAppROG5rgIVSGcw6HiOsfkLW_carbzBNLVOtpZ3NvLDrLHYoZfFJMUm7n_AEXFSuVWej0kol9jPW5dzrsLcEY1HKq1_jJaE1EsEa4n42gVlGBPnon1MI8t8p1weynG0n9zD1vCREqeuJYjfPzCDHQcI1cxsqn18L5IM1XmfUL44FYKAH8bBwOE9Ar2yDOA1MfOL6G8aqlK6BhYmrap5VJJshmJrvyFBRYcOMV_N0_3-982m_HtnjJyKjcLfIBkEWnArIeHeto-vPGV82w4LbuElUHMiPdVvCqvQaFAsu3dM461zSOboNNVww4FwE_HVseWx_MC7fOx8pT4Tb3xiKZFwCVkIdmUX1y57pQAMcY5yd3UQJpk1diJKT5_lk40lgSuHPyBCK01Wy5e3dnM_xMzyAa0LfFCB8ijs0trwd8ayUX7mXqTOfqBPVFe0R0el-Jq4UsSX6nNYp99DHRCKERIddIKW39t8yWJmGetwHEYndDybhVEJ56XZrjWWkNORrXk-JTttuy1Fc4cldpBubP1Q40cLR-VNn5PNOj5V5FE7Wpa0xvXy1zh3Oe5bpkdUkgQZZYX9lTdt8YDALWyA-wbXnL5wnoyYCuQXxGnAQB5g0SKRofAMLgY_ZpZFMbYDP14DRyGm1QeTC-9sPvOlrfl4e1u47fkCbvSQjZeozRIPS56dhTvtqEuipUpNjSTl2W0mtd1IsAyU15xz_ycgdrm1-psqeQtL1gTm_OF5MdHF0n46SYBUejQOAWuaWSU37abP5Tq3bpK47sq5lEVFfNSTKBPjGNrdoDffpiDlO_w6aQqSQBIkcV6VrrTsnf8gr7vWbleGWzNtI2IBgPertPwHsDycIJPfdEHQLOzhLkD0nLtbnHvUVL71596IKDgDq0cldM8b6Gx5BYkjZcwUs0AViecMrf16m9L3ECcOFbe3jmvrUT8VXmwB0mTSFGQvETSSoaJSHzTLPeQUYxri9OnQ4GqQlQKni5dLYGo4vpqlSipWiynXaGOQ3Ns3AMEKBM96WKrSMJ-QX9x_R25NQLgcgKSjVunfmbQP_ZDz4nFILAXKcIpZsKvs10oA4yKHzs853INlltctgEVDlvf8kQrAriNCHJvx7bFUqgGwxyC1wHVQLbhCQe4oq2SAyRGsPviPwphizbjbM976BoenuvZ1HqE3P-BMFrPZ4eDEJcRphsOkkTWcHWvurwRdABzGXJ1bfMpHwcfgzRvU-zm6vfkc0s8WuIl1Q_w8O9Ea3fIsGl1pfuhoR1DtJ6kL5Rl-U1SyqRj3cJr9iBhjgV3MzbQKqOozTxUn3yBZUhV4oWuOQO4fg5u6DA1eARZwYAOdGRDrUaMfubY4qpmOWFXxzaqjYP4UC9oirRyaWZSHPtZ-UgAcLEpR6oz-GbQTDxiwn4Yb2YyrFO3gka15gyrIUY_q9c-Xsa9CNBcAi5dLl7VB12dVfMYUOp-S0tXd8eGpC3S1yI1N1rpGJA9vn5Xe3KFacsDLBu8mTCcghpCQoo1X1B95lVYByDmrEA72I20ePk3l2GYOQaMPWXL9GzMzn4Eq8PoGyqSFJwAAaS5uT54Vy_deXUrESz2s_LvD79rMgZ7IqDVntKyrgbKKpXbZqW0_BDtGZp4i_xArp8AkZ6LPC1grhvR7FdcLhyJgZFrhDdbWFTYRHD6PC_V14YqtFqCFMalTThJqjvkGOM833yq9DhPp0_CnalhU6ShGFmawqlT9Y_P7gVDDAq9Eie9aQwAenxEj-ryuJ4OVeZfXT1ZD7OpMyC7VzKGmVr6EDlRqv3g4qLln2DKYyTTu6rfYQbi3wbQ763ld2Ha7oMwnlqZ_ByCUqHGNgclvW_KBzWxOjgtNPTy05OBdMwbVx7JwuBTnuphLhwxYBcg34XAue788EdJLjFHeRhSKJYhdyMrQ0JVZ4jcCi6Gof5Vnm8pXBC4jLvEvOnRiG9H31iIPF_y8Wo_80zwFxxyG4b4fjMv3Ed67Txk1RBaoUF5E4hMCgfs2Jkpne421xQxWOs9W7aPAeP71_zyOK7hKKi4_H9zfgelIOVMW7oRt7q2fNW01jSU5eoEwiJyS9Hv91VbZoeEdx40Ad_fPwoKcS6nit_cB6OxHWRRoG1txG7LCJ8ykf1Qs0C4zgEi_cLnPQ40Bh5u4l_EdfgqClO4H7LEHlh-x-_yEeH4Oh3cNRwv8eiq3HB83thAP76CV77At2wbcEldCwAlNXh8mk4LEGnx50GrnE349ZdSzlxshZLjp44oq4L4toHW5zWGoyZE4hvZPjOhrkeAEnjzL3bPhYDbyAOfXxr8n2eKlwGZTl79-3ifdpBSczTciFFI2ZBea0MZx6VzNM8NXk_I2BKZvhFnupHORtRUaEAHxOojpusFvE90V5bkXeP4rS-KWoZGCttFK3ChseIGLkrET681cYMpafsiSm5rbnoDBWnOWwmTvn_B8aO5LMCkzFbyvVScu17kTy_coD0rujA1MGGHRZP--GhL_JH3HHr8iCjXIq3nbmdcR6ATXAwksXe1yrLbpQjMD9HLbaxwC9KYuLNVpvXbze8coEuxGJrFpGOTy3vHBtx2n_-LcIcV4bqDqKZopMwzoEIdhg3YBA6zqv6NH0HDci_YyAQmkfIKtIuDsdQsNAKLKDhi_-IpyqG06UsJmeCdNiWaRPbQcXO6ZdbB73PDoMMjdSTQC50bJoDuacIk2b9D0LdXvDVFJLuWFq-xeCljgJGDV9UmhLA19jXsZCo4fy5XT_2MxlJgr7yKP3A_-PFiUI9gfuN1bjNv6ilNMPvs6sRzGwXhFXaYl8QP_NXM-X-QQXm_Qr8b8jIhTrvfB4Q20M-5HjYJEhptfWbkVRmsDCnhedCSyZ_bM2riDjFZvsmoTLXviMXZGpMDZDYjDrp2LSh8m84AxLDD53BggPyjzdPywe_2_h-Pjrd-qTNE2HmfJQGTog8gDaCX6uVbCLRw==
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		gAAAAABcsJqAYXk9JKu5xP_9NpHlYuWcYf5RuyU9rZ_xKPvco4cJAkA2H9vk8P6Yl1VFslqGAyWR-v4fTYScJi1LavLXIASOlBN_mh-ElL2wD21LYuaRkiP8ox7Yf9yqkPLxqm_SZcSBnWaM1Ub1qqzteyg6GHNldD8__UqDmjSjYesuN2_i_NcmOLtcrhbfoJbhIK1w0N8agafGLY1Nt5kMIfOtHR8zFJuwgI2Uc5WzTaImYbbhsqWgfe3L5DppZe-_DqMMOXnOUOjjrvQgPD5p10VIj27VIoVA7B8frGSVhABTBEoO3ErkIinkgOlmRDbY_bsxeXpMs4Lg5QHA6y-XQCp-yRMYtesOW8lzvlpVZGCy1Z3NoD7Slx2siUvPW9YE07o0qpp8zLlL26nSboMoXmdA_ua8ABoZ05bPnDyqHCdYSkCAkB_lh5VgkKAEiFiSvEcBw3FVok-sNsDX_tXS5mvPR1WHHxxrqnMQeYEW9JzqhnWkMmtxiEPxOfJSnpo7g8oECFqfsNPHo_3uGPTtQJb2KmRTd3nD4hVPN7vHBshD801pgShnKn6q3XrFggC2QMYQnrZRY9YgzuUrUJK9i1AhTcRsg8ftq2rPjtlArq6DszVwuNn1m2Kee7fV4AHyombO84bpxEkKcoxyQy7CHQ1e3ZMQVbZ_9T95C8a0y2IvSZ93rjQ5uR2xGAdjrLoDyBy_zDlNim62rF4VtcPvUhw2kjQpzMrLxL0cx4CI7iURPbqmFnXCwhkk1MBRBtsLBiJuBjd18ko33U6A_B0SyJQaOzgd-lmP19BBtwT3dssOYWQFsLpr6jXciFy2C6-4Nye27kC2CCwIDCH7l2qwMJhAhe3qbNJoWVVQpwu8RVhnEn-pG5IBIY3vvLVej0M1bGYUfE0wiFgI8gq9kUTQmOc0fP__osYY3bOF8P997izlIs9-RqhoRhdv1hWmvui1i6qk2FrFRIXhMPIroYLqsOyZ_hSyZCBkvGWk0h-WeyXfsCNkOwlwI_40swIH7ZdB2SFx9_n727YoFN4MBbZiXg3vGXC0ci0Gp3LjE36TCkiAAUZr9qcPNjxjYOl0hSlNRlCVnECNpb-d1Qut5LCL8gPzcUYMzTl5jbPaiJL-1NDE-YNE4v9NasvZMwORAphORdyKf7Z07_KAhJDInlWKMaOPPJc8HU49VcKBrIZNG1UCCCZ74ky8bvL1k5Y9Ur3WnWOVofsfnyP7QFUoyV11KZ0ckI8_jNbgSOo89jV5yhk6pKi_pPsYviybMe8VMXFVBDMTf52PbFodSsW_6wEbp2kZ6bIXRuHQANiktefdTFYdM7MjftAeQFJdJJvtSpiVH4EMAKxq8HH2xWq9VroWFR0s_HIPzSeuZxOjwJpY5RhMxY0TbFsFq55tfFKVdScJxG0ZUm0FnvkDME9KHMjEshProHD3lWiv7YkQFpPJ7i_bCFYMjp6CP27Gzjrr1PSTDb7r8jeA17kUAppROG5rgIVSGcw6HiOsfkLW_carbzBNLVOtpZ3NvLDrLHYoZfFJMUm7n_AEXFSuVWej0kol9jPW5dzrsLcEY1HKq1_jJaE1EsEa4n42gVlGBPnon1MI8t8p1weynG0n9zD1vCREqeuJYjfPzCDHQcI1cxsqn18L5IM1XmfUL44FYKAH8bBwOE9Ar2yDOA1MfOL6G8aqlK6BhYmrap5VJJshmJrvyFBRYcOMV_N0_3-982m_HtnjJyKjcLfIBkEWnArIeHeto-vPGV82w4LbuElUHMiPdVvCqvQaFAsu3dM461zSOboNNVww4FwE_HVseWx_MC7fOx8pT4Tb3xiKZFwCVkIdmUX1y57pQAMcY5yd3UQJpk1diJKT5_lk40lgSuHPyBCK01Wy5e3dnM_xMzyAa0LfFCB8ijs0trwd8ayUX7mXqTOfqBPVFe0R0el-Jq4UsSX6nNYp99DHRCKERIddIKW39t8yWJmGetwHEYndDybhVEJ56XZrjWWkNORrXk-JTttuy1Fc4cldpBubP1Q40cLR-VNn5PNOj5V5FE7Wpa0xvXy1zh3Oe5bpkdUkgQZZYX9lTdt8YDALWyA-wbXnL5wnoyYCuQXxGnAQB5g0SKRofAMLgY_ZpZFMbYDP14DRyGm1QeTC-9sPvOlrfl4e1u47fkCbvSQjZeozRIPS56dhTvtqEuipUpNjSTl2W0mtd1IsAyU15xz_ycgdrm1-psqeQtL1gTm_OF5MdHF0n46SYBUejQOAWuaWSU37abP5Tq3bpK47sq5lEVFfNSTKBPjGNrdoDffpiDlO_w6aQqSQBIkcV6VrrTsnf8gr7vWbleGWzNtI2IBgPertPwHsDycIJPfdEHQLOzhLkD0nLtbnHvUVL71596IKDgDq0cldM8b6Gx5BYkjZcwUs0AViecMrf16m9L3ECcOFbe3jmvrUT8VXmwB0mTSFGQvETSSoaJSHzTLPeQUYxri9OnQ4GqQlQKni5dLYGo4vpqlSipWiynXaGOQ3Ns3AMEKBM96WKrSMJ-QX9x_R25NQLgcgKSjVunfmbQP_ZDz4nFILAXKcIpZsKvs10oA4yKHzs853INlltctgEVDlvf8kQrAriNCHJvx7bFUqgGwxyC1wHVQLbhCQe4oq2SAyRGsPviPwphizbjbM976BoenuvZ1HqE3P-BMFrPZ4eDEJcRphsOkkTWcHWvurwRdABzGXJ1bfMpHwcfgzRvU-zm6vfkc0s8WuIl1Q_w8O9Ea3fIsGl1pfuhoR1DtJ6kL5Rl-U1SyqRj3cJr9iBhjgV3MzbQKqOozTxUn3yBZUhV4oWuOQO4fg5u6DA1eARZwYAOdGRDrUaMfubY4qpmOWFXxzaqjYP4UC9oirRyaWZSHPtZ-UgAcLEpR6oz-GbQTDxiwn4Yb2YyrFO3gka15gyrIUY_q9c-Xsa9CNBcAi5dLl7VB12dVfMYUOp-S0tXd8eGpC3S1yI1N1rpGJA9vn5Xe3KFacsDLBu8mTCcghpCQoo1X1B95lVYByDmrEA72I20ePk3l2GYOQaMPWXL9GzMzn4Eq8PoGyqSFJwAAaS5uT54Vy_deXUrESz2s_LvD79rMgZ7IqDVntKyrgbKKpXbZqW0_BDtGZp4i_xArp8AkZ6LPC1grhvR7FdcLhyJgZFrhDdbWFTYRHD6PC_V14YqtFqCFMalTThJqjvkGOM833yq9DhPp0_CnalhU6ShGFmawqlT9Y_P7gVDDAq9Eie9aQwAenxEj-ryuJ4OVeZfXT1ZD7OpMyC7VzKGmVr6EDlRqv3g4qLln2DKYyTTu6rfYQbi3wbQ763ld2Ha7oMwnlqZ_ByCUqHGNgclvW_KBzWxOjgtNPTy05OBdMwbVx7JwuBTnuphLhwxYBcg34XAue788EdJLjFHeRhSKJYhdyMrQ0JVZ4jcCi6Gof5Vnm8pXBC4jLvEvOnRiG9H31iIPF_y8Wo_80zwFxxyG4b4fjMv3Ed67Txk1RBaoUF5E4hMCgfs2Jkpne421xQxWOs9W7aPAeP71_zyOK7hKKi4_H9zfgelIOVMW7oRt7q2fNW01jSU5eoEwiJyS9Hv91VbZoeEdx40Ad_fPwoKcS6nit_cB6OxHWRRoG1txG7LCJ8ykf1Qs0C4zgEi_cLnPQ40Bh5u4l_EdfgqClO4H7LEHlh-x-_yEeH4Oh3cNRwv8eiq3HB83thAP76CV77At2wbcEldCwAlNXh8mk4LEGnx50GrnE349ZdSzlxshZLjp44oq4L4toHW5zWGoyZE4hvZPjOhrkeAEnjzL3bPhYDbyAOfXxr8n2eKlwGZTl79-3ifdpBSczTciFFI2ZBea0MZx6VzNM8NXk_I2BKZvhFnupHORtRUaEAHxOojpusFvE90V5bkXeP4rS-KWoZGCttFK3ChseIGLkrET681cYMpafsiSm5rbnoDBWnOWwmTvn_B8aO5LMCkzFbyvVScu17kTy_coD0rujA1MGGHRZP--GhL_JH3HHr8iCjXIq3nbmdcR6ATXAwksXe1yrLbpQjMD9HLbaxwC9KYuLNVpvXbze8coEuxGJrFpGOTy3vHBtx2n_-LcIcV4bqDqKZopMwzoEIdhg3YBA6zqv6NH0HDci_YyAQmkfIKtIuDsdQsNAKLKDhi_-IpyqG06UsJmeCdNiWaRPbQcXO6ZdbB73PDoMMjdSTQC50bJoDuacIk2b9D0LdXvDVFJLuWFq-xeCljgJGDV9UmhLA19jXsZCo4fy5XT_2MxlJgr7yKP3A_-PFiUI9gfuN1bjNv6ilNMPvs6sRzGwXhFXaYl8QP_NXM-X-QQXm_Qr8b8jIhTrvfB4Q20M-5HjYJEhptfWbkVRmsDCnhedCSyZ_bM2riDjFZvsmoTLXviMXZGpMDZDYjDrp2LSh8m84AxLDD53BggPyjzdPywe_2_h-Pjrd-qTNE2HmfJQGTog8gDaCX6uVbCLRw==