Fixed #34846 -- Added copy button to code snippets on the documentation #18247
Conversation
Co-authored-by: Alexander Lötvall <[email protected]> Co-authored-by: Saarthak Maini <[email protected]> Co-authored-by: Venkata Bhaskar <[email protected]>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello! Thank you for your contribution 💪
As it's your first contribution be sure to check out the patch review checklist.
If you're fixing a ticket from Trac make sure to set the "Has patch" flag and include a link to this PR in the ticket!
If you have any design or process questions then you can ask in the Django forum.
Welcome aboard ⛵️!
| @@ -2,3 +2,4 @@ pyenchant | |||
| Sphinx>=4.5.0 | |||
| sphinxcontrib-spelling | |||
| blacken-docs | |||
| sphinx-copybutton | |||
There was a problem hiding this comment.
Thanks for the PR!
Is there a way to achieve this without adding this as a new dependency?
I'm slightly concerned about the maintenance status of the underlying js library. What do you think?
There was a problem hiding this comment.
Thanks for the response, and yeah most probably there is, I will look into it.
There was a problem hiding this comment.
What’s your concern @smithdc1? Anecdotally we’ve been using this same dependency for the Wagtail docs for two years now, haven’t had a problem yet.
There was a problem hiding this comment.
@arthurvasconcelos did you see the comment on the last PR that this conflicts with JavaScript in djangoproject.com and perhaps should be solved there rather than adding a dependency here?
|
I've been trying to see how this change would actually look like once deployed to docs.djangoproject.com and it has been more challenging than I had thought (the djangoproject website does not use I hope to be able to get to the bottom of this in the upcoming week, but please ping me if I forget 😁 |
Trac ticket number
Done during Django Conference Europe 2024 sprint 🎉
ticket-34846
Branch description
This solution will use the sphinx framework provided copy-button to copy the whole code. On the original PR(#16342) I found this comment #16342 (comment) which I struggle to understand why this solution would conflict. When checking https://github.com/django/djangoproject.com/blob/main/djangoproject/static/js/mod/clippify.js I found them to be different projects using different frameworks, could some extra context be provided on the possible conflict?
Light:
Dark:
I couldn't find how to switch to dark mode.
Checklist
mainbranch.