[docs] [issue13435] Copybutton does not hide tracebacks

Robert Lehmann report at bugs.python.org
Sat Nov 19 18:42:23 CET 2011

New submission from Robert Lehmann <lehmannro at gmail.com>:

The recently added copybutton.js (r18bbfed9aafa) does not work with the 2.7 docs since they are deployed with JQuery 1.2 (which is shipped with Sphinx 0.6).

Copybutton is an unobtrusive Javascript feature which adds a little button to all doctests that removes the interactive prompts in order to copy the code as-is into Python scripts.  I think that feature could well be ported to Sphinx itself.

In line 44 and 51 of Doc/tools/sphinxext/static/copybutton.js the code uses jQuery.nextUntil(), which is new in JQuery 1.4.  That results in tracebacks being only partially hidden.  Reproduce the error at http://docs.python.org/tutorial/errors.html#exceptions for example.

The Python 3.2+ documentation is not affected as it is built with Sphinx 1.0, which ships with JQuery 1.4.  JQuery Untils are available as a separate plugin (http://benalman.com/projects/jquery-untils-plugin/).

assignee: docs at python
components: Documentation
messages: 147962
nosy: docs at python, ezio.melotti, lehmannro
priority: normal
severity: normal
status: open
title: Copybutton does not hide tracebacks
type: behavior
versions: Python 2.7

Python tracker <report at bugs.python.org>

More information about the docs mailing list