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

Some documentation #45

Merged
merged 3 commits into from
Aug 30, 2021
Merged

Some documentation #45

merged 3 commits into from
Aug 30, 2021

Conversation

JeffFessler
Copy link
Member

@JeffFessler JeffFessler commented Aug 13, 2021

Hopefully addresses #38 by showing all the docstrings via Documenter.

(This does not set up complete docs but hopefully will be a useful starting point.)

@codecov
Copy link

codecov bot commented Aug 13, 2021

Codecov Report

Merging #45 (aa410d7) into master (2c0e54c) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #45   +/-   ##
=======================================
  Coverage   76.85%   76.85%           
=======================================
  Files           8        8           
  Lines         216      216           
=======================================
  Hits          166      166           
  Misses         50       50           

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 2c0e54c...aa410d7. Read the comment docs.

@coveralls
Copy link

coveralls commented Aug 13, 2021

Pull Request Test Coverage Report for Build 1128307714

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+1.4%) to 64.211%

Totals Coverage Status
Change from base Build 1128172929: 1.4%
Covered Lines: 183
Relevant Lines: 285

💛 - Coveralls

@JeffFessler
Copy link
Member Author

@ivanslapnicar
can you add a DOCUMENTER_KEY to this repo following the instructions here:
https://juliadocs.github.io/Documenter.jl/stable/lib/public/#DocumenterTools.genkeys
so that Documenter can deploy?
I do not have permissions to do that myself...

@JeffFessler
Copy link
Member Author

@dlfivefifty are you able to add a DOCUMENTER_KEY to this repo?

@JeffFessler
Copy link
Member Author

@dlfivefifty I see that you synced up the doc branch, thanks, but were you able to add a DOCUMENTER_KEY?
I can't directly see the presence or absence of that key from my view. But it looks like it's not there because the pages didn't deploy:
https://juliamatrices.github.io/SpecialMatrices.jl/dev

And even thought github shows that "all checks have passed" the BuildAndDeploy part of the Documentation check shows that it failed to deploy:
https://github.com/JuliaMatrices/SpecialMatrices.jl/pull/45/checks?check_run_id=3451806955

@dlfivefifty
Copy link
Member

Should be fixed now

@JeffFessler JeffFessler merged commit 19351f8 into master Aug 30, 2021
@JeffFessler JeffFessler deleted the doc branch August 30, 2021 11: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.

3 participants