Skip to content

Conversation

asmeurer
Copy link
Member

@asmeurer asmeurer commented Apr 7, 2022

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

  • other
    • Add the sphinx-copybutton extension to the docs.

@sympy-bot
Copy link

sympy-bot commented Apr 7, 2022

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:

  • other

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.
This adds a button that copies the code in doctest example blocks.

I also updated the docs installation instructions to just use requirements.txt. 

<!-- Your title above should be a short description of what
was changed. Do not include the issue number in the title. -->

#### References to other Issues or PRs
<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
format, e.g. "Fixes #1234" (see
https://tinyurl.com/auto-closing for more information). Also, please
write a comment on that issue linking back to this pull request once it is
open. -->


#### Brief description of what is fixed or changed


#### Other comments


#### Release Notes

<!-- Write the release notes for this release below between the BEGIN and END
statements. The basic format is a bulleted list with the name of the subpackage
and the release note for this PR. For example:

* solvers
  * Added a new solver for logarithmic equations.

* functions
  * Fixed a bug with log of integers.

or if no release note(s) should be included use:

NO ENTRY

See https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more
information on how to write release notes. The bot will check your release
notes automatically to see if they are formatted correctly. -->

<!-- BEGIN RELEASE NOTES -->
- other
  - Add the sphinx-copybutton extension to the docs.
<!-- END RELEASE NOTES -->

Update

The release notes on the wiki have been updated.

@github-actions
Copy link

github-actions bot commented Apr 7, 2022

Benchmark results from GitHub Actions

Lower numbers are good, higher numbers are bad. A ratio less than 1
means a speed up and greater than 1 means a slowdown. Green lines
beginning with + are slowdowns (the PR is slower then master or
master is slower than the previous release). Red lines beginning
with - are speedups.

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
(click on checks at the top of the PR).

@bertiewooster
Copy link
Contributor

bertiewooster commented Apr 8, 2022

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.

Copy link
Contributor

@bertiewooster bertiewooster left a 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.

@asmeurer asmeurer merged commit 9c7ebdd into sympy:master Apr 8, 2022
@asmeurer
Copy link
Member Author

asmeurer commented Apr 8, 2022

Thanks for the review.

@ghost
Copy link

ghost commented Apr 10, 2022

Thank You Sir @asmeurer for adding the copy-button, I was planning to do the same but thought I should discuss that if it is okay to add the copy-button or for some reasons it is not added.
I posted the message on gitter regarding the same with image on March 7 but no one responded at that time but thanks I wanted this expecially while learning more and more about sympy from the documentation : )

@bertiewooster
Copy link
Contributor

@KuldeepBorkar Thanks for suggesting the copy-button. As @asmeurer noted in analyzing the documentation survey, the gitter site is little used:

The Gitter chat room is the least popular response, with only 7.5% of respondents claiming to use it. It may be worth revisiting whether the chatroom is beneficial to the community.

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.

@asmeurer
Copy link
Member Author

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.

@asmeurer
Copy link
Member Author

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.

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