upbge
upbge copied to clipboard
Some PyDoc documents has invalid formatted text.
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.
I just compiled the pydoc and I got this warning only. @IzaZed it comes from packnewtree.py:
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.
@lordloki @IzaZed
Is there any update about this issue? I think this will collapse the generated document as well.