upbge icon indicating copy to clipboard operation
upbge copied to clipboard

Some PyDoc documents has invalid formatted text.

Open nutti opened this issue 8 months ago • 3 comments

Currently bpy.ops.logic_node.rst and other rst documents have invalid format texts.

  • Current format (Invalid)
.. function:: pack_new_tree(*, new_tree_name="NewTree")

   Convert selected Nodes to a new tree. Will be applied to selected object.
WARNING: All Nodes connected to selection must be selected too    <--- This is not correct format
  • Corrected format
.. function:: pack_new_tree(*, new_tree_name="NewTree")

   Convert selected Nodes to a new tree. Will be applied to selected object.
   WARNING: All Nodes connected to selection must be selected too

This invalid format will raise an error when we parse rst file by using docstring package.

nutti avatar Aug 21 '25 15:08 nutti

I just compiled the pydoc and I got this warning only. @IzaZed it comes from packnewtree.py:

Image

lordloki avatar Aug 21 '25 21:08 lordloki

Hi @lordloki

There is also another invalid format.

.. function:: install_uplogic()

   Downloads the latest version of the uplogic module required for running logic nodes.

NOTE: This may take a few seconds and requires internet connection.   <----- Invalid format

I think we should fix sphinx_gen_doc.py instead of fixing individual codes.

nutti avatar Aug 22 '25 14:08 nutti

@lordloki @IzaZed

Is there any update about this issue? I think this will collapse the generated document as well.

nutti avatar Oct 26 '25 06:10 nutti