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.

Sign up for GitHub

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

Jump to bottom

add documentation #67

Merged
merged 25 commits into from
Apr 15, 2024
Merged

add documentation #67

merged 25 commits into from
Apr 15, 2024

Conversation

michal367
Copy link
Collaborator

List of changes:

  • added documentation (to generate full html output, you need Doxygen, Sphinx, Breathe, and Renku Sphinx theme)
  • added building documentation to setup.sh and setup.bat scripts (BUILD_DOCUMENTATION option)
  • changed README.md
  • adjusted example code and unit tests for a new gamma index calculation example in documentation
  • improved examples
  • improved code documentation
  • improved plot script (plot_gamma_times.py) - text in SVG is saved as text and not as paths; added possibility to set a time unit (ms or s); added possibility to set precision of values above bars
  • removed reviewpad

closed #34, closed #42, closed #58, closed #66

@michal367 michal367 requested a review from grzanka April 2, 2024 17:20
@michal367 michal367 self-assigned this Apr 2, 2024
grzanka
grzanka reviewed Apr 2, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@michal367 michal367 merged commit b0babb3 into master Apr 15, 2024
8 checks passed
@michal367 michal367 deleted the documentation branch April 15, 2024 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@grzanka grzanka grzanka approved these changes

Assignees

@michal367 michal367

Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@michal367 @grzanka