Skip to content

Create Readable Documentation #39

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

Merged
merged 17 commits into from
Mar 3, 2022
Merged

Create Readable Documentation #39

merged 17 commits into from
Mar 3, 2022

Conversation

hillmich
Copy link
Contributor

  • Streamline README.md
  • Put elaborate documentation on ReadTheDocs

- Old version in docs/ as reference when creating RtD
@hillmich hillmich added the documentation Improvements or additions to documentation label Feb 24, 2022
@hillmich hillmich self-assigned this Feb 24, 2022
@codecov
Copy link

codecov bot commented Feb 24, 2022

Codecov Report

Merging #39 (46e2948) into master (53a866b) will decrease coverage by 0.0%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           master     #39     +/-   ##
========================================
- Coverage    88.5%   88.5%   -0.1%     
========================================
  Files          20      20             
  Lines        2389    2389             
========================================
- Hits         2116    2115      -1     
- Misses        273     274      +1     
Impacted Files Coverage Δ
src/ShorSimulator.cpp 60.5% <0.0%> (-0.3%) ⬇️
src/ShorFastSimulator.cpp 94.4% <0.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 53a866b...46e2948. Read the comment docs.

@hillmich hillmich requested a review from burgholzer March 2, 2022 15:18
Copy link
Member

@burgholzer burgholzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As expected, the most critical comments are targeting the README.
The other stuff should be easy to incorporate.

@hillmich hillmich requested a review from burgholzer March 3, 2022 17:54
@hillmich hillmich marked this pull request as ready for review March 3, 2022 17:59
@hillmich hillmich merged commit 442cfe5 into master Mar 3, 2022
@hillmich hillmich deleted the documentation branch March 3, 2022 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants