New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doctest skipif may remove the code block from documentation #6068
Comments
Could you give any example? |
contents.rst: .. doctest::
>>> 1
1
.. doctest::
:skipif: True
>>> 2
2
.. doctest::
:skipif: False
>>> 3
3 Tested as follows: $ sphinx-build -b html -C -D extensions=sphinx.ext.doctest . out/
$ lynx -dump out/contents.html
#[1]Index [2]Search
>>> 1
1
>>> 3
3
... It is missing:
in the output. |
Thank you for example. confirmed. Surely, this is not intentional. |
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Feb 27, 2019
…lock from documentation
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Feb 28, 2019
…lock from documentation
tk0miya
added a commit
that referenced
this issue
Feb 28, 2019
Fix #6068: doctest: ``skipif`` option may remove the code block from documentation
Fixed by #6115. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Doctest
:skipif:
option (introduced in #5307) may unintentionally remove the code in doctest from documentation.Ideally, the
:skipif:
condition would be evaluated only by the doctest builder.The text was updated successfully, but these errors were encountered: