Fix GH #54853: BUG: DeprecationWarning for frontend.OptionParser when building docs #54854
Conversation
| @@ -159,10 +159,10 @@ def _get_page_title(self, page): | |||
| Open the rst file `page` and extract its title. | |||
| """ | |||
| fname = os.path.join(SOURCE_PATH, f"{page}.rst") | |||
| option_parser = docutils.frontend.OptionParser( | |||
| components=(docutils.parsers.rst.Parser,) | |||
| doc = docutils.utils.new_document( | |||
There was a problem hiding this comment.
Can you use something like this instead? https://stackoverflow.com/a/75996218
There was a problem hiding this comment.
We could, but my understanding from the docs is that this version allows customization through a configuration file, whereas the SO answer does not. So I'd lean on keeping it like it is, but I'm happy to change the PR if you'd prefer.
(This is assuming you're not talking about supporting docutils prior to 0.18. Otherwise let me know.)
There was a problem hiding this comment.
Yeah I was referring to using get_default_settings. I would prefer using more "public" APIs from docutils rather then digging into docutils.core
There was a problem hiding this comment.
Updated as requested :)
…ontend.OptionParser
|
Thanks @DavidToneian |
DavidToneian
deleted the
fix-GH-54853-DeprecationWarning-frontend.OptionParser
branch
…arser when building docs (pandas-dev#54854) * Fix GH pandas-dev#54853: BUG: DeprecationWarning for frontend.OptionParser when building docs See docutils/docutils@6548b56#diff-a033583f6ace19fed2adc108b1c130e17ea00e1afee38c22c993cb477ad27a5fR453 * Use `docutils.frontend.get_default_settings` instead of relying on `docutils.core`. --------- Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com>
frontend.OptionParserwhen building docs #54853 (Replace xxxx with the GitHub issue number)doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.See docutils/docutils@6548b56#diff-a033583f6ace19fed2adc108b1c130e17ea00e1afee38c22c993cb477ad27a5fR453