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

DOC: Documentation improvements #121

Merged
merged 31 commits into from May 3, 2020

Conversation

scottclowe
Copy link
Member

Tidy up the documentation

  • Add example usage to the README
  • List links to notebooks with different versions in a table format
  • Improve installation instructions
  • Add more details to jupyter notebooks
  • Make jupyter notebooks more consistent (e.g. roi plotting helper function)
  • Add figure showing all rois on top of mean image to basic notebook
  • Add citation.ris
  • Change index and README page headings on sphinx documentation (readthedocs)
  • Add intro section to index page on sphinx documentation (readthedocs)

@scottclowe scottclowe added the doc label May 2, 2020
@scottclowe scottclowe requested a review from swkeemink May 2, 2020 19:04
@codecov
Copy link

codecov bot commented May 2, 2020

Codecov Report

Merging #121 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #121   +/-   ##
=======================================
  Coverage   80.40%   80.40%           
=======================================
  Files           9        9           
  Lines         740      740           
  Branches      139      139           
=======================================
  Hits          595      595           
  Misses        109      109           
  Partials       36       36           

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 49118f9...49118f9. Read the comment docs.

@scottclowe scottclowe merged commit e0d7bc8 into rochefort-lab:master May 3, 2020
@scottclowe scottclowe deleted the doc_tidyup branch May 3, 2020 13:20
This was referenced May 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant