paudetseis / Telewavesim

Teleseismic body wave modeling through stacks of (submarine/anisotropic) layers

https://paudetseis.github.io/Telewavesim/

MIT License

66 stars 18 forks source link

Ci doc #29

Closed trichter closed 5 years ago

trichter commented 5 years ago

This PR tries to fix #28.

I removed the docs build from master, added the rst files, tested building the documentation locally and set up the .travis.yml file.

A deploy key or access token is still missing. I think a deploy key would be better, but it seems it is more difficult to set it up. @paudetseis you can add more necessary commits on top of this branch.

Here is a good guide: I don't know if it needs to be followed till the end because the new travis deploy api as an explicit deploy_key option.

codecov-io commented 5 years ago

Codecov Report

Merging #29 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #29   +/-   ##
=======================================
  Coverage   55.98%   55.98%           
=======================================
  Files           9        9           
  Lines        1136     1136           
=======================================
  Hits          636      636           
  Misses        500      500

Impacted Files	Coverage Δ
telewavesim/utils.py	`72.22% <0%> (ø)`	:arrow_up:
telewavesim/__init__.py	`100% <0%> (ø)`	:arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 1e0e0f1...f840bef. Read the comment docs.

trichter commented 5 years ago

Building the docs with travis-ci is working, see this travis job. @paudetseis, you can test the deployment to github pages with the necessary key or token on this branch, but after everything works we need to delete the all_branches: true line again. Then, the docs are only deployed for the master branch.

It appears the merging into master must be done manually on the command line after that.

paudetseis commented 5 years ago

@trichter I followed the instructions for setting up the SSH key with Travis to the end. Please check that I didn't mess up the .travis.yml file. The encrypted key is now in .travis/

If everything works, please merge with master

trichter commented 5 years ago

Great. I will have time to finish this PR at the beginning of next week.