UCL-ARC / householder

A native Rust library for advanced Linear Algebra routines
https://docs.rs/householder/latest/householder/
Apache License 2.0
23 stars 5 forks source link

Add documentation building to CI #18

Closed dstansby closed 1 year ago

dstansby commented 2 years ago

Builds on top of https://github.com/UCL-ARC/householder/pull/17 to add a documentation build on GH actions. I also enabled some strict documentation options, and where I could added some docstrings.

codecov-commenter commented 2 years ago

Codecov Report

Merging #18 (d8e7475) into main (833af3b) will increase coverage by 2.96%. The diff coverage is 81.66%.

@@            Coverage Diff             @@
##             main      #18      +/-   ##
==========================================
+ Coverage   76.15%   79.11%   +2.96%     
==========================================
  Files          24       25       +1     
  Lines         717      886     +169     
==========================================
+ Hits          546      701     +155     
- Misses        171      185      +14     
Impacted Files Coverage Δ
src/addition.rs 92.10% <ø> (-1.00%) :arrow_down:
src/base_matrix.rs 93.93% <ø> (ø)
src/data_container.rs 100.00% <ø> (ø)
src/layouts/arbitrary_stride_column_major.rs 0.00% <ø> (ø)
src/layouts/arbitrary_stride_column_vector.rs 0.00% <ø> (ø)
src/layouts/arbitrary_stride_row_major.rs 78.57% <ø> (ø)
src/layouts/arbitrary_stride_row_vector.rs 0.00% <ø> (ø)
src/layouts/column_major.rs 10.34% <ø> (ø)
src/layouts/column_vector.rs 51.61% <ø> (ø)
src/layouts/row_major.rs 89.65% <ø> (ø)
... and 24 more

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more