feature request: configurability of copyability

[kratsg]

from scikit-hep/pyhf#721

a simple way is to add a configuration to allow for the last line to be copied or skipped. This should handle both cases. Additionally, could add a configuration indicating if the project wants to use >>> and ... so then you can just not copy lines that don't start with that.

In order to be a bit more flexible about how code snippets can be copied, it is true that there is no enforced consistency so that as of right now, the entire code-block is copied. This issue requests two separate things:

1. The ability to toggle on/off whether the last line in a code-block should be copied (this doesn't necessarily assume a language)
2. The ability to toggle on/off whether lines without >>> or ... should be copied (note: this one assumes python)
3. Perhaps in the future, similar to above, the ability to toggle whether lines without > or $ should be copied

[mgeier]

I wonder if this effort could be somehow combined with https://github.com/sbrunner/sphinx-prompt?

[choldgraf]

What if we just added an extra True/False flag to what we already have, that allows authors to say "if a code block has the >>> in it, then only copy the lines that start with >>> and skip the rest (after stripping the >>>).

[lukasheinrich]

alternatively some configuration to specify which lines to copy (ignoring all other lines)

{"match_lines": ["^>>>","^..."], strip_match=true}

[choldgraf]

Just a note for future ref:

To get allow for multiple strings in the conf.py value, we should use something like this in the template:

{% if copybutton_skip_text is string %}'{{ copybutton_skip_text }}'{% else %}{{ copybutton_skip_text }}{% endif %}

(or just force it to be a list instead of allowing for just a string

[mgeier]

As mentioned in #59, I think it would be good to take inspiration from the "copy button" in the Python docs, see e.g. https://docs.python.org/3/tutorial/controlflow.html

The corresponding code is in https://github.com/python/python-docs-theme/blob/master/python_docs_theme/static/copybutton.js

[chrisjsewell]

As @lukasheinrich alludes to, the prompts should also be regexes, in particular to handle ipython type prompts:

In [1]: x = 2

In [2]: x**3
Out[2]: 8

[chrisjsewell]

In fact if its a regex, you don't need to have multiple strings, just e.g.

copybutton_lines_regex = "^(>>>|...|In\s*\[\d*\]\:)(.*)"

[choldgraf]

I agree with regexes, just haven't had the time so a PR is welcome. I'm not so sure about forcing people to use regexes though since most are not comfortable with them

[chrisjsewell]

Yes I was thinking this as well: those pesky amateur users! Perhaps keep copybutton_prompt_text as is, and converted it on the fly to a regex before injecting into the javascript. Then also have the copybutton_lines_regex for "power users" which, if set, will override copybutton_prompt_text

[choldgraf]

that makes sense to me 👍