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

2029 update contributing docs.md for references thumbnails viewing rtd build #2053

Conversation

bdg221
Copy link
Collaborator

@bdg221 bdg221 commented Oct 16, 2023

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

  • [ X] I license this contribution under the terms of the GNU GPL, version 3 and grant Unitary Fund the right to provide additional permissions as described in section 7 of the GNU GPL, version 3.

Before opening the PR, please ensure you have completed the following where appropriate.

  • [ X] I added unit tests for new code.
  • [ X] I used type hints in function signatures.
  • [ X] I used Google-style docstrings for functions.
  • [X ] I updated the documentation where relevant.
  • [X ] Added myself / the copyright holder to the AUTHORS file

@codecov
Copy link

codecov bot commented Oct 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (68b2b12) 98.30% compared to head (028fe24) 98.30%.
Report is 18 commits behind head on master.

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           

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nathanshammah
Copy link
Member

Nice PR, thanks @bdg221!

Copy link
Member

@andreamari andreamari left a 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

docs/CONTRIBUTING_DOCS.md Outdated Show resolved Hide resolved
docs/CONTRIBUTING_DOCS.md Outdated Show resolved Hide resolved
Co-authored-by: Andrea Mari <andreamari84@gmail.com>
@Misty-W Misty-W merged commit 26a85d2 into unitaryfund:master Oct 26, 2023
14 of 16 checks passed
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.

Add section to contributing_docs.md about adding references
4 participants