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

Add copy buttons for documentation #365

Merged
merged 11 commits into from
Jul 1, 2022
Merged

Add copy buttons for documentation #365

merged 11 commits into from
Jul 1, 2022

Conversation

amageh
Copy link
Collaborator

@amageh amageh commented Jun 26, 2022

Implements suggestions from issue #341. The package sphinx-copybutton adds buttons to all code blocks in the documentation, so I added code blocks for the algorithms and installation page.

@codecov
Copy link

codecov bot commented Jun 26, 2022

Codecov Report

Merging #365 (5b6610f) into main (89a7e4e) will decrease coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #365      +/-   ##
==========================================
- Coverage   93.61%   93.58%   -0.03%     
==========================================
  Files         191      191              
  Lines       15357    15357              
==========================================
- Hits        14376    14372       -4     
- Misses        981      985       +4     
Impacted Files Coverage Δ
...ptimization/subsolvers/bounded_newton_quadratic.py 85.08% <0.00%> (-0.88%) ⬇️
...magic/optimization/subsolvers/_trsbox_quadratic.py 84.08% <0.00%> (-0.82%) ⬇️

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 89a7e4e...5b6610f. Read the comment docs.

@amageh amageh requested a review from janosg June 27, 2022 08:29
Copy link
Member

@janosg janosg left a comment

Choose a reason for hiding this comment

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

Very nice. Thanks a lot!

Could you add quotes around the algorithms? i.e. "scipy_lbfgsb" instead of scipy_lbfgsb. I think that would make it more convenient if you really want to use the copied code.

Copy link
Member

@janosg janosg left a comment

Choose a reason for hiding this comment

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

Thank you very much @amageh. Great work as always!

@janosg janosg merged commit fc575ea into main Jul 1, 2022
@janosg janosg deleted the copy-button branch July 1, 2022 09:24
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.

3 participants