-
-
Notifications
You must be signed in to change notification settings - Fork 167
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
2029 update contributing docs.md for references thumbnails viewing rtd build #2053
2029 update contributing docs.md for references thumbnails viewing rtd build #2053
Conversation
…md-for-references-thumbnails-viewing-RTD-build
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2053 +/- ##
=======================================
Coverage 98.30% 98.30%
=======================================
Files 87 87
Lines 4118 4125 +7
=======================================
+ Hits 4048 4055 +7
Misses 70 70 ☔ View full report in Codecov by Sentry. |
Nice PR, thanks @bdg221! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very good and useful! Thanks @bdg221
Co-authored-by: Andrea Mari <[email protected]>
Fixes #2029
This PR addresses 3 documentation issues:
1.) Add a section to the documentation for adding references in the Mitiq bibliography when updating / adding documentation.
2.) Add a section to the Jupyter notebook example documentation for adding a thumbnail.
3.) Add a section to the Contributing to the Docs for viewing the Read The Docs from a PR build.
License
Before opening the PR, please ensure you have completed the following where appropriate.