Page MenuHome

Docs: Fixes and improvements in API documentation
ClosedPublic

Authored by Xavier Cho (mysticfall) on Sep 25 2021, 10:34 PM.

Details

Summary

Fixes several notable mistakes and missing information
regarding the API documentation (*.rst).

This will allow API stub generators like bpystubgen or
fake-bpy-module to produce more accurate result.

Diff Detail

Repository
rB Blender
Branch
fix-rst-errors (branched from master)
Build Status
Buildable 17313
Build 17313: arc lint + arc unit

Event Timeline

Xavier Cho (mysticfall) requested review of this revision.Sep 25 2021, 10:34 PM
Xavier Cho (mysticfall) created this revision.

I have a question, by the way. I'm using nodeitem_utils module in my project which is used to register custom node categories and items (e.g. to extend the shader editor) but it looks like it is not included in the source list in sphinx_doc_gen.py.

I wonder if the omission is intentional since the API is not meant to be public, or it's just because no one has written a proper documentation for it yet? If the latter is the case, I'm willing to update this patch to allow Sphinx to generate documentation for the module as well. Currently, it's the only part that makes my IDE report errors when I use the stubs API generated with my bpystubgen project, so I'm motivated to contribute.

This revision is now accepted and ready to land.Sep 28 2021, 4:12 AM
Aaron Carlisle (Blendify) retitled this revision from Fixes and improvements in API documentation to Docs: Fixes and improvements in API documentation.Sep 28 2021, 4:12 AM

@Xavier Cho (mysticfall) yes documentation can be added for those modules.