FriesischScott / UncertaintyQuantification.jl

Uncertainty Quantification in Julia
MIT License
28 stars 7 forks source link

Add basic documentation #32

Closed AnderGray closed 3 years ago

AnderGray commented 3 years ago

Adds a template for GitHub documentation.

If all is well, then a docs page will be hosted in a gh-pages branch when the PR is merged.

Locally the API-docstrings says the functions are missing. I believe this because I'm using the registered version instead of the master branch. Not sure if this will be a problem in the online version.

FriesischScott commented 3 years ago

The documentation has to be build against the branch and not the registered version.

codecov[bot] commented 3 years ago

Codecov Report

Merging #32 (5588608) into master (8cdc686) will increase coverage by 0.04%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #32      +/-   ##
==========================================
+ Coverage   99.64%   99.69%   +0.04%     
==========================================
  Files          14       14              
  Lines         284      323      +39     
==========================================
+ Hits          283      322      +39     
  Misses          1        1              
Impacted Files Coverage Δ
src/inputs/inputs.jl 100.00% <ø> (ø)
src/inputs/parameter.jl 100.00% <ø> (ø)
src/inputs/randomvariable.jl 100.00% <ø> (ø)
src/inputs/jointdistribution.jl 100.00% <100.00%> (ø)
src/models/polyharmonicspline.jl 96.96% <100.00%> (+0.41%) :arrow_up:
src/sensitivity/gradient.jl 100.00% <100.00%> (ø)
src/simulations/subset.jl 100.00% <100.00%> (ø)
src/models/model.jl 100.00% <0.00%> (ø)
... and 10 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 8cdc686...5588608. Read the comment docs.

FriesischScott commented 3 years ago

@AnderGray I think we should just merge like this and then gradually improve on the documentation. Ideally we would do this now but I am way to lazy for that :smile:.

I made a few changes:

What do you think?

FriesischScott commented 3 years ago

I don't exactly understand why pull_request_target fails pull_request fails, but I will remove the required check on the former.

AnderGray commented 3 years ago

All the changes look good to me.

Happy to merge once we fix the pull_request_target fail

FriesischScott commented 3 years ago

I'll remove pull_request_target in favor of pull_request. I tried the former to enable coverage stats for pull requests made from other repos. Didn't work though.