You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@arrow.apache.org by "Joris Van den Bossche (Jira)" <ji...@apache.org> on 2021/12/02 11:38:00 UTC

[jira] [Comment Edited] (ARROW-14963) [Doc] Add extensions to code-blocks

    [ https://issues.apache.org/jira/browse/ARROW-14963?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17452351#comment-17452351 ] 

Joris Van den Bossche edited comment on ARROW-14963 at 12/2/21, 11:37 AM:
--------------------------------------------------------------------------

Adding my comment here as well: 

Apparently, sphinx actually already supports having a {{$}} not copy-pastable out of the box (see eg https://pydata-sphinx-theme.readthedocs.io/en/latest/contributing.html#set-up-a-basic-development-environment), I _think_ it's a matter of specifying the correct highlighting language for the code blocks (`console` was used in the case of the linked example)

Apart from that, a copy button from {{sphinx-copybutton}} extension can still be useful in addition, though. 


was (Author: jorisvandenbossche):
Adding my comment here as well: 


> [Doc] Add extensions to code-blocks
> -----------------------------------
>
>                 Key: ARROW-14963
>                 URL: https://issues.apache.org/jira/browse/ARROW-14963
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Alenka Frim
>            Priority: Minor
>              Labels: GoodForNewContributors, beginner, beginner-friendly, good-first-issue
>
> We could add Sphinx extensions to the existing Development part of the documentation so that users will be able to copy-paste code from the code-blocks. Need to make sure that only the code is copied and not $ with it for example.
> See the link for ideas:
> [https://github.com/pydata/pydata-sphinx-theme/issues/41]



--
This message was sent by Atlassian Jira
(v8.20.1#820001)