Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setting up the docs with ReadTheDocs #11

Merged
merged 19 commits into from Jan 13, 2021

Conversation

jbusecke
Copy link
Collaborator

@jbusecke jbusecke commented Jan 12, 2021

I have set up a dummy doc folder that is built as part of the CI each time a Pull Request is made.

@codecov-io
Copy link

codecov-io commented Jan 12, 2021

Codecov Report

Merging #11 (17d7723) into master (7b8d290) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #11   +/-   ##
=======================================
  Coverage   84.61%   84.61%           
=======================================
  Files           4        4           
  Lines          26       26           
=======================================
  Hits           22       22           
  Misses          4        4           
Flag Coverage Δ
unittests 84.61% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


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 7b8d290...17d7723. Read the comment docs.

@jbusecke jbusecke marked this pull request as draft January 12, 2021 15:45
@jbusecke jbusecke marked this pull request as ready for review January 12, 2021 15:54
@jbusecke
Copy link
Collaborator Author

The RTD build is not triggered for this PR. I am not sure if it was right to set up RTD from my personal GH account?
I think this is basically an issue of authenticating RTD under Applications see here. @rabernat could you check if you can connect it from the org side?

@rabernat
Copy link
Contributor

If you set it up from your personal account, I think you will have to set up the webhook yourself.

Go to https://github.com/ocean-eddy-cpt/gcm-filters/settings/hooks

Then follow the instructions here:

https://docs.readthedocs.io/en/latest/webhooks.html#github

@rabernat
Copy link
Contributor

A RTD build did run! https://readthedocs.org/projects/gcm-filters/builds/12748970/

But maybe not on the PR?

@rabernat
Copy link
Contributor

bingo, had to enable PR builds on RTD

@jbusecke
Copy link
Collaborator Author

Nice! Thanks @rabernat. Ill finish this up now.

@jbusecke
Copy link
Collaborator Author

All right. I think this is good to go. Check the docs out here: https://gcm-filters--11.org.readthedocs.build/en/11/

@rabernat
Copy link
Contributor

This is great Julius! Thanks so much!

@rabernat rabernat merged commit 09ed575 into ocean-eddy-cpt:master Jan 13, 2021
@jbusecke jbusecke deleted the start_docs branch January 13, 2021 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consolidating configs in pyproj.toml create documentation stub
3 participants