Skip to content

Sphinx 5 Compatibility: nodes.Node.traverse() is obsoleted by Node.findall() #22

@lukasjuhrich

Description

@lukasjuhrich

Similarly to numpy/numpydoc#399, I get a PendingDeprecationWarning when building my docs using sphinx-paramlinks:

[…snip…]
/opt/pycroft/venv/lib/python3.11/site-packages/sphinx_paramlinks/sphinx_paramlinks.py:195: PendingDeprecationWarning: nodes.Node.traverse() is obsoleted by Node.findall().
  for ref in self.document.traverse(nodes.strong):                                                                               
/opt/pycroft/venv/lib/python3.11/site-packages/sphinx_paramlinks/sphinx_paramlinks.py:146: PendingDeprecationWarning: nodes.Node.traverse() is obsoleted by Node.findall().
  for ref in self.document.traverse(addnodes.pending_xref):                                                                      
reading sources... [100%] search                                                                                                 
/opt/pycroft/venv/lib/python3.11/site-packages/sphinx_paramlinks/sphinx_paramlinks.py:195: PendingDeprecationWarning: nodes.Node.traverse() is obsoleted by Node.findall().
  for ref in self.document.traverse(nodes.strong):          
/opt/pycroft/venv/lib/python3.11/site-packages/sphinx_paramlinks/sphinx_paramlinks.py:146: PendingDeprecationWarning: nodes.Node.traverse() is obsoleted by Node.findall().
  for ref in self.document.traverse(addnodes.pending_xref):

I don't know much about the internals here, but here are the reference docs for findall.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions