sphinx/tests/test_extensions/test_ext_ifconfig.py

"""Test sphinx.ext.ifconfig extension."""

import docutils.utils
import pytest

from sphinx import addnodes
from sphinx.testing import restructuredtext


@pytest.mark.sphinx('text', testroot='ext-ifconfig')
def test_ifconfig(app, status, warning):
    app.build(force_all=True)
    result = (app.outdir / 'index.txt').read_text(encoding='utf8')
    assert 'spam' in result
    assert 'ham' not in result


def test_ifconfig_content_line_number(app):
    app.setup_extension("sphinx.ext.ifconfig")
    text = (".. ifconfig:: confval1\n" +
            "\n" +
            "   Some link here: :ref:`abc`\n")
    doc = restructuredtext.parse(app, text)
    xrefs = list(doc.findall(condition=addnodes.pending_xref))
    assert len(xrefs) == 1
    source, line = docutils.utils.get_source_line(xrefs[0])
    assert 'index.rst' in source
    assert line == 3
Collapse single line docstrings 2022-02-19 21:05:56 -06:00			`"""Test sphinx.ext.ifconfig extension."""`
Closes #1748: SyntaxError in sphinx/ext/ifconfig.py with Python 2.6. 2015-03-02 07:43:14 -06:00
Add ``content_offset`` parameter to ``nested_parse_with_titles`` (#11147) Previously, ``nested_parse_with_titles`` always passed ``0`` as the input offset when invoking ``nested_parse``. When parsing the content of a directive, as is a common use case for ``nested_parse_with_titles``, this leads to incorrect source file/line number information, as it does not take into account the directive's ``content_offset``, which is always non-zero. This issue affects all object descriptions due to GH-10887. It also affects the ``sphinx.ext.ifconfig`` extension. The ``py:module`` and ``js:module`` directives employed a workaround for this issue, by wrapping the calls to ``nested_parse_with_title`` with ``switch_source_input``. That worked, but was more complicated (and likely less efficient) than necessary. This commit adds an optional ``content_offset`` parameter to ``nested_parse_with_titles``, and fixes callers to pass the appropriate content offset when needed. This commit eliminates the now-unnecessary calls to ``switch_source_input`` and instead specifies the correct ``content_offset``. 2023-02-14 23:45:28 -06:00			`import docutils.utils`
pytest: remove deprecated with_app decorator functions 2017-01-05 10:14:47 -06:00			`import pytest`
Closes #1748: SyntaxError in sphinx/ext/ifconfig.py with Python 2.6. 2015-03-02 07:43:14 -06:00
Add ``content_offset`` parameter to ``nested_parse_with_titles`` (#11147) Previously, ``nested_parse_with_titles`` always passed ``0`` as the input offset when invoking ``nested_parse``. When parsing the content of a directive, as is a common use case for ``nested_parse_with_titles``, this leads to incorrect source file/line number information, as it does not take into account the directive's ``content_offset``, which is always non-zero. This issue affects all object descriptions due to GH-10887. It also affects the ``sphinx.ext.ifconfig`` extension. The ``py:module`` and ``js:module`` directives employed a workaround for this issue, by wrapping the calls to ``nested_parse_with_title`` with ``switch_source_input``. That worked, but was more complicated (and likely less efficient) than necessary. This commit adds an optional ``content_offset`` parameter to ``nested_parse_with_titles``, and fixes callers to pass the appropriate content offset when needed. This commit eliminates the now-unnecessary calls to ``switch_source_input`` and instead specifies the correct ``content_offset``. 2023-02-14 23:45:28 -06:00			`from sphinx import addnodes`
			`from sphinx.testing import restructuredtext`

Closes #1748: SyntaxError in sphinx/ext/ifconfig.py with Python 2.6. 2015-03-02 07:43:14 -06:00
pytest: remove deprecated with_app decorator functions 2017-01-05 10:14:47 -06:00			`@pytest.mark.sphinx('text', testroot='ext-ifconfig')`
Closes #1748: SyntaxError in sphinx/ext/ifconfig.py with Python 2.6. 2015-03-02 07:43:14 -06:00			`def test_ifconfig(app, status, warning):`
Organise tests into directories 2024-01-16 20:38:46 -06:00			`app.build(force_all=True)`
`.read_text()` -> `.read_text(encoding='utf8')` 2022-04-26 21:04:19 -05:00			`result = (app.outdir / 'index.txt').read_text(encoding='utf8')`
Optimize tests: test_ifconfig 2016-07-13 19:16:51 -05:00			`assert 'spam' in result`
			`assert 'ham' not in result`
Add ``content_offset`` parameter to ``nested_parse_with_titles`` (#11147) Previously, ``nested_parse_with_titles`` always passed ``0`` as the input offset when invoking ``nested_parse``. When parsing the content of a directive, as is a common use case for ``nested_parse_with_titles``, this leads to incorrect source file/line number information, as it does not take into account the directive's ``content_offset``, which is always non-zero. This issue affects all object descriptions due to GH-10887. It also affects the ``sphinx.ext.ifconfig`` extension. The ``py:module`` and ``js:module`` directives employed a workaround for this issue, by wrapping the calls to ``nested_parse_with_title`` with ``switch_source_input``. That worked, but was more complicated (and likely less efficient) than necessary. This commit adds an optional ``content_offset`` parameter to ``nested_parse_with_titles``, and fixes callers to pass the appropriate content offset when needed. This commit eliminates the now-unnecessary calls to ``switch_source_input`` and instead specifies the correct ``content_offset``. 2023-02-14 23:45:28 -06:00

			`def test_ifconfig_content_line_number(app):`
			`app.setup_extension("sphinx.ext.ifconfig")`
			`text = (".. ifconfig:: confval1\n" +`
			`"\n" +`
			" Some link here: :ref:`abc`\n")
			`doc = restructuredtext.parse(app, text)`
			`xrefs = list(doc.findall(condition=addnodes.pending_xref))`
			`assert len(xrefs) == 1`
			`source, line = docutils.utils.get_source_line(xrefs[0])`
			`assert 'index.rst' in source`
			`assert line == 3`