Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ Deprecated
including ``builder.app``, ``env.app``, ``events.app``,
and ``SphinxTransform.`app``.
Patch by Adam Turner.
* #13637: Deprecate the :py:meth:`!set_application` method
of :py:class:`~sphinx.parsers.Parser` objects.
Sphinx now directly sets the :py:attr:`!config` and :py:attr:`!env` attributes.
Patch by Adam Turner.

Features added
--------------
Expand Down
5 changes: 4 additions & 1 deletion sphinx/parsers.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
from docutils.statemachine import StringList
from docutils.transforms.universal import SmartQuotes

from sphinx.deprecation import _deprecation_warning
from sphinx.util.rst import append_epilog, prepend_prolog

if TYPE_CHECKING:
Expand Down Expand Up @@ -44,7 +45,9 @@ def set_application(self, app: Sphinx) -> None:

:param sphinx.application.Sphinx app: Sphinx application object
"""
self._app = app
cls_module = self.__class__.__module__
cls_name = self.__class__.__qualname__
_deprecation_warning(cls_module, f'{cls_name}.set_application', remove=(10, 0))
self.config = app.config
self.env = app.env

Expand Down
3 changes: 2 additions & 1 deletion sphinx/registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,8 @@ def create_source_parser(self, app: Sphinx, filename: str) -> Parser:
parser_class = self.get_source_parser(filename)
parser = parser_class()
if isinstance(parser, SphinxParser):
parser.set_application(app)
parser.config = app.config
parser.env = app.env
return parser

def add_translator(
Expand Down
3 changes: 2 additions & 1 deletion sphinx/testing/restructuredtext.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ def parse(app: Sphinx, text: str, docname: str = 'index') -> nodes.document:
reader = SphinxStandaloneReader()
reader.setup(app)
parser = RSTParser()
parser.set_application(app)
parser.config = app.config
parser.env = app.env
with sphinx_domains(env):
return publish_doctree(
text,
Expand Down
3 changes: 2 additions & 1 deletion tests/test_markup/test_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ def test_RSTParser_prolog_epilog(RSTStateMachine, app):
document = new_document('dummy.rst')
document.settings = Mock(tab_width=8, language_code='')
parser = RSTParser()
parser.set_application(app)
parser.config = app.config
parser.env = app.env

# normal case
text = 'hello Sphinx world\nSphinx is a document generator'
Expand Down
Loading