[issue36675] Doctest directives and comments missing from code samples

Change by Ming Hua : -- nosy: +minghua ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue36675] Doctest directives and comments missing from code samples

Jim DeLaHunt added the comment: My goodness, things get complex sometimes. If we cannot make Sphinx preserve doctest directives and comments, perhaps we should go back to the historical bug discussion to look at workarounds which we considered earlier. For instance, maybe we should modify

[issue36675] Doctest directives and comments missing from code samples

Julien Palard added the comment: Due to https://github.com/python/cpython/pull/24282 this is sadly un-fixed. Either we find another way to fix this, either we wait 3 releases and we re-commit https://github.com/python/cpython/pull/23620. -- resolution: fixed -> later stage: resolved

[issue36675] Doctest directives and comments missing from code samples

Anthony Sottile added the comment: should the minimum sphinx version be bumped and/or this reverted: https://github.com/python/cpython/blob/f7f0ed59bcc41ed20674d4b2aa443d3b79e725f4/Doc/conf.py#L48 this change breaks, for example, sphinx 1.8.5 while building for ubuntu 20.04 The directive

[issue36675] Doctest directives and comments missing from code samples

Julien Palard added the comment: Happy Christmas, everybody involved in this issue! I'm happy to announce this issue is resolved since a few days \o/ -- resolution: -> fixed stage: patch review -> resolved status: open -> closed ___ Python

[issue36675] Doctest directives and comments missing from code samples

Julien Palard added the comment: New changeset c8a10d2fabff492ab352501c316baf5f2fc6510e by Julien Palard in branch 'master': bpo-36675: Doc: Reveal doctest directives (GH-23620) https://github.com/python/cpython/commit/c8a10d2fabff492ab352501c316baf5f2fc6510e --

[issue36675] Doctest directives and comments missing from code samples

Change by Julien Palard : -- pull_requests: +22488 pull_request: https://github.com/python/cpython/pull/23620 ___ Python tracker ___

[issue36675] Doctest directives and comments missing from code samples

Jim DeLaHunt added the comment: We discovered and fixed this same problem back in 2011-2012 with #12947 . That was apparently the source of the monkeypatch that was removed as "obselete code" on 2019-09-12. That old issue commentary has some suggestions about other workarounds. This

[issue36675] Doctest directives and comments missing from code samples

miss-islington added the comment: New changeset 94a684734f669eab02b5c915394b749ccf936449 by Miss Islington (bot) in branch '3.8': bpo-36675: Remove obsolete code. (GH-16024) https://github.com/python/cpython/commit/94a684734f669eab02b5c915394b749ccf936449 -- nosy: +miss-islington

[issue36675] Doctest directives and comments missing from code samples

Gregory P. Smith added the comment: New changeset 2c910c1e732c9a3ec4c67a7c43d789d6c729304a by Gregory P. Smith (Julien Palard) in branch 'master': bpo-36675: Remove obsolete code. (GH-16024) https://github.com/python/cpython/commit/2c910c1e732c9a3ec4c67a7c43d789d6c729304a -- nosy:

[issue36675] Doctest directives and comments missing from code samples

Change by miss-islington : -- pull_requests: +15653 pull_request: https://github.com/python/cpython/pull/16030 ___ Python tracker ___

[issue36675] Doctest directives and comments missing from code samples

Change by Julien Palard : -- pull_requests: +15647 pull_request: https://github.com/python/cpython/pull/16024 ___ Python tracker ___

[issue36675] Doctest directives and comments missing from code samples

Julien Palard added the comment: I opened an issue on the sphinx-doc repo [1] to check if it would be possible to have an option in doctest blocks to not trim them. We previously had a hack in Doc/tools/extensions/pyspecific.py to patch sphinx to not trim them for the doctest.rst file. But

[issue36675] Doctest directives and comments missing from code samples

Cheryl Sabella added the comment: ;tldr; There is a global configuration flag to show all the doctest directives for all the docs that are built. The default is to suppress the doctest directives. If a global setting isn't desired, then each doctest example will have to be changed

[issue36675] Doctest directives and comments missing from code samples

Steven D'Aprano added the comment: > Doctest directives in code examples should be suppressed everywhere > *except* in the doctest.html examples showing how to use directives. > The patch only exposes them for doctest.html and not for ctypes or > anywhere else. Thanks for the patch, and

[issue36675] Doctest directives and comments missing from code samples

Jeroen Demeyer added the comment: > Doctest directives in code examples should be suppressed everywhere *except* > in the doctest.html examples showing how to use directives. Thanks for clarifying. I missed that. -- ___ Python tracker

[issue36675] Doctest directives and comments missing from code samples

Terry J. Reedy added the comment: Doctest directives in code examples should be suppressed everywhere *except* in the doctest.html examples showing how to use directives. The patch only exposes them for doctest.html and not for ctypes or anywhere else. They really should not be in the dir

[issue36675] Doctest directives and comments missing from code samples

Éric Araujo added the comment: OP is about the documentation page for doctest itself! -- ___ Python tracker ___ ___

[issue36675] Doctest directives and comments missing from code samples

Jeroen Demeyer added the comment: Isn't it a *feature* that those doctest directives are not shown? Those directives are meant for the doctest module only, not for the reader of the rendered documentation. -- nosy: +jdemeyer ___ Python tracker

[issue36675] Doctest directives and comments missing from code samples

Change by Roundup Robot : -- keywords: +patch pull_requests: +13038 stage: needs patch -> patch review ___ Python tracker ___ ___

[issue36675] Doctest directives and comments missing from code samples

Terry J. Reedy added the comment: I verified that the line in Doc/library/doctest.rst has the comment. " For example, this test passes:: >>> print(list(range(20))) # doctest: +NORMALIZE_WHITESPACE [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19] "