Meta:Tools/Sphinx/Sidebar
目次
Trees
Attributes tree
Index of all the attributes (classes, constants, functions) in a certain module, to avoid scrolling a lot
Operators
Example: http://www.blender.org/documentation/blender_python_api_2_56_0/bpy.ops.mesh.html
+ functions <-- collapsible
- beautify_fill()
- blend_from_shape()
- colors_mirror()
- ...
+ constants <-- collapsible
- foo
- bar
- baz
Types
Example: http://www.blender.org/documentation/blender_python_api_2_56_0/bpy.types.ColorRamp.html
we have:
+ constants <-- collapsible
- elements
- ...
+ data <-- collapsible
- interpolation
- ...
+ methods <-- collapsible
- evaluate()
- ...
This example is short I know: if the elements are less than X we keep subfolders open, otherwise we collapse them
Modules tree
Be able to jump to whichever module we want in the api
Inheritance tree
Nested levels (collapsible folders) of the hierachy of all classes in the API, so that we know the parents of each class
OR, if this is problematic, the hierarchy of classes related to the class we are viewing in types (I'd prefer the first tho)
Inherited attributes indentation
It'd be fantastic if a class page like http://www.blender.org/documentation/blender_python_api_2_56_0/bpy.types.ColorRamp.html
shows *inherited* attributes, so to show for example id_data; the same should be done for inherited methods (those listed below)
Idea: add a small icon like "arrow-up" linking to the parent class or something