-
-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Add the sphinx-copybutton extension to the docs #23335
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
Conversation
This adds a button that copies the code in doctest example blocks.
✅ Hi, I am the SymPy bot (v163). I'm here to help you write a release notes entry. Please read the guide on how to write release notes. Your release notes are in good order. Here is what the release notes will look like: This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.11. Click here to see the pull request description that was parsed.
Update The release notes on the wiki have been updated. |
Benchmark results from GitHub Actions Lower numbers are good, higher numbers are bad. A ratio less than 1 Significantly changed benchmark results (PR vs master) Significantly changed benchmark results (master vs previous release) before after ratio
[77f1d79c] [c38bd35c]
<sympy-1.10.1^0>
+ 121±2ms 215±2ms 1.77 sum.TimeSum.time_doit
Full benchmark results can be found as artifacts in GitHub Actions |
I checked out this branch, built the documentation, and verified that the copy button works for copying code blocks. Code changes seem good as well. I recommend merging. |
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.
Code changes are logical.
Thanks for the review. |
Thank You Sir @asmeurer for adding the |
@KuldeepBorkar Thanks for suggesting the
so unfortunately it seems that no one who was working on the Sphinx theme update noticed your comment there. When there is an open pull request or issue on GitHub, I believe posting there is the best way to ensure that a related idea is noted by those already working on it. This example suggests that the gitter site may be doing more harm than good: @KuldeepBorkar diligently posted a great suggestion, and it was not noted by those working on the feature. I suggest we seriously consider shutting down SymPy's gitter to avoid similar problems in the future, instead funneling communication through a smaller number of platforms. |
Let's discuss the gitter thing on the mailing list. In general, if you have a feature suggestion, it's best to open an issue for it or use an existing issue or PR if relevant. |
Also if you are looking for things to do regarding improving the documentation, there are still plenty of things that can be done. Just take a look at the "Documentation" label on the issue tracker. |
This adds a button that copies the code in doctest example blocks.
I also updated the docs installation instructions to just use requirements.txt.
References to other Issues or PRs
Brief description of what is fixed or changed
Other comments
Release Notes