invenia / Models.jl

An interface package that defines the methods and types for working with models.
MIT License
3 stars 0 forks source link

Tidy up README and docs #2

Closed glennmoy closed 4 years ago

nickrobinson251 commented 4 years ago

Need to update docs/make.jl

from repo="https://gitlab.invenia.ca/invenia/Models.jl/blob/{commit}{path}#L{line}" to repo=repo="https://github.com/invenia/Models.jl/blob/{commit}{path}#L{line}",

nickrobinson251 commented 4 years ago

there's a (ref) missing the @ on L43 of src/Models.jl

nickrobinson251 commented 4 years ago

Need to add deploydocs to bottom of docs/make.jl

deploydocs(;
    repo="github.com/invenia/Models.jl",
    push_preview=true,
)

And also follow the instructions on hosting docs

codecov[bot] commented 4 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (master@de5d4ad). Click here to learn what that means. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master       #2   +/-   ##
=========================================
  Coverage          ?   91.04%           
=========================================
  Files             ?        3           
  Lines             ?       67           
  Branches          ?        0           
=========================================
  Hits              ?       61           
  Misses            ?        6           
  Partials          ?        0           

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 de5d4ad...37462d7. Read the comment docs.

glennmoy commented 4 years ago

Need to add deploydocs to bottom of docs/make.jl

deploydocs(;
    repo="github.com/invenia/Models.jl",
    push_preview=true,
)

And also follow the instructions on hosting docs

Nothing to add to the YAML file from what I can see. I just need to add ssh deploy keys?