Mailing List Archive

[issue12947] Examples in library/doctest.html lack the flags
Stefano Taschini <taschini@ieee.org> added the comment:

Concrete examples can be seen in the section

http://docs.python.org/library/doctest.html#option-flags-and-directives

For instance at

http://docs.python.org/library/doctest.html#doctest.IGNORE_EXCEPTION_DETAIL

The doctest flags present in the sources in

http://docs.python.org/_sources/library/doctest.txt

are all stripped.

----------
nosy: +taschini

_______________________________________
Python tracker <report@bugs.python.org>
<http://bugs.python.org/issue12947>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com
[issue12947] Examples in library/doctest.html lack the flags [ In reply to ]
Éric Araujo <merwok@netwok.org> added the comment:

Thank you. I think it’s clear that for the docs of the doctest flags we need to display snippets with the flags.

----------
resolution: invalid ->
stage: committed/rejected -> test needed
status: closed -> open

_______________________________________
Python tracker <report@bugs.python.org>
<http://bugs.python.org/issue12947>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com
[issue12947] Examples in library/doctest.html lack the flags [ In reply to ]
Stefano Taschini <taschini@ieee.org> added the comment:

As far as I can see, Sphinx has a global setting for trim_doctest_flags but lacks the possibility of locally disabling the trimming.

A quick workaround would be to have the following sphinx extension added:

class ProxyLexer(object):

def __init__(self, underlying):
self.__underlying = underlying

def __getattr__(self, attr):
return getattr(self.__underlying, attr)

def setup(app):
from sphinx.highlighting import lexers
if lexers is not None:
lexers['pycon-literal'] = ProxyLexer(lexers['pycon'])
lexers['pycon3-literal'] = ProxyLexer(lexers['pycon3'])

That would allow blocks marked as

.. code-block:: pycon-literal

or preceded by

.. highlight:: pycon-literal

to escape the trimming of doctest flags.

If that's of any interest I can submit a patch.

----------

_______________________________________
Python tracker <report@bugs.python.org>
<http://bugs.python.org/issue12947>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com
[issue12947] Examples in library/doctest.html lack the flags [ In reply to ]
Ezio Melotti <ezio.melotti@gmail.com> added the comment:

Is there a way to add a :keep-doctest-flags: options to literal blocks?

----------
stage: test needed -> needs patch
type: -> enhancement

_______________________________________
Python tracker <report@bugs.python.org>
<http://bugs.python.org/issue12947>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com
[issue12947] Examples in library/doctest.html lack the flags [ In reply to ]
Stefano Taschini <taschini@ieee.org> added the comment:

Ezio, the patch I attached goes into that direction, by adding a ":trim-doctest-flags: disable" option to the code blocks.

I thought I had a good reason for having the option worded as ":trim-doctest-flags: disable" instead of ":keep-doctest-flags:", now I'm not so sure.

Note: the patch is against the 2.7 branch.

----------
keywords: +patch
Added file: http://bugs.python.org/file25424/issue12947_v0.patch

_______________________________________
Python tracker <report@bugs.python.org>
<http://bugs.python.org/issue12947>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com