Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

DOC: remove SKIP in the rst doctests

See original GitHub issue

There are plenty of +SKIP doctests directives in the documentation. Ideally, we should not need them, see #14970 for background information.

Procedure: edit the rst files to make the tests more robust or correct. Then, run

python tools/refguide_check.py --rst

to check the result.

This issue should be considered after #15848

Issue Analytics

State:
Created 3 years ago
Reactions:2
Comments:15 (15 by maintainers)

Top GitHub Comments

2reactions

pdebuylcommented, Oct 20, 2021

Hi all following here: In branch https://github.com/pdebuyl/numpy/tree/fix_doctest_for_pytest I have

pytest --doctest-glob=“*.rst” doc/source/reference

passing except for file doc/source/reference/arrays.nditer.cython.rst

Also,

python tools/refguide_check.py --rst

passes.

If that is appropriate, I would like to submit a PR of the above branch to make progress in the line of testing the docs with pytest https://github.com/numpy/numpy/issues/15845

The number of SKIP directives is now rather limited, this issue could be closed as well.

2reactions

cmarmocommented, Sep 30, 2021

Hello, sorry for stepping in. Just referencing #19898 here because it is fixing part of this issue.

Top Results From Across the Web

Remove #doctest: +SKIP where possible · Issue #6959 · sympy ...

Here is a copy of the list: So looking through `git grep -A 3 "doctest: +SKIP"`, it looks like we still skip the...

Python doctest: Skip entire block? - Stack Overflow

Doctest's +SKIP directive only works per line, which would mean adding 10s of lines to my real-world example. Ugly!

doctest — Test interactive Python examples — Python 3.11.1 ...

First import ``factorial`` from the ``example`` module: >>> from example ... That doctest succeeds if ValueError is raised, with the list.remove(x): x not ......

sphinx.ext.doctest - Sphinx documentation

This extension allows you to test such code snippets in the documentation in a natural way. If you mark the code blocks as...

Run/Debug Configuration: Doctests - PyCharm - JetBrains

If doctests are presented as separate files, PyCharm allows opening such files as reStructuredText files with .rst extension. Such files are marked with...