Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc/python_api
AgeCommit message (Collapse)Author
2021-07-20Fix API doc generation after recent context additionsJulian Eisel
2021-07-06Cleanup: pep8Campbell Barton
2021-06-22PyDoc: Update Sphinx and pin dependenciesAaron Carlisle
Sphinx has rather loose dependency requirements which can cause issues if we aren't careful. As a solution they recommend that you pin sphinx dependency versions
2021-06-08PyAPI: use keyword only argumentsCampbell Barton
Use keyword only arguments for the following functions. - addon_utils.module_bl_info 2nd arg `info_basis`. - addon_utils.modules 1st `module_cache`, 2nd arg `refresh`. - addon_utils.modules_refresh 1st arg `module_cache`. - bl_app_template_utils.activate 1nd arg `template_id`. - bl_app_template_utils.import_from_id 2nd arg `ignore_not_found`. - bl_app_template_utils.import_from_path 2nd arg `ignore_not_found`. - bl_keymap_utils.keymap_from_toolbar.generate 2nd & 3rd args `use_fallback_keys` & `use_reset`. - bl_keymap_utils.platform_helpers.keyconfig_data_oskey_from_ctrl 2nd arg `filter_fn`. - bl_ui_utils.bug_report_url.url_prefill_from_blender 1st arg `addon_info`. - bmesh.types.BMFace.copy 1st & 2nd args `verts`, `edges`. - bmesh.types.BMesh.calc_volume 1st arg `signed`. - bmesh.types.BMesh.from_mesh 2nd..4th args `face_normals`, `use_shape_key`, `shape_key_index`. - bmesh.types.BMesh.from_object 3rd & 4th args `cage`, `face_normals`. - bmesh.types.BMesh.transform 2nd arg `filter`. - bmesh.types.BMesh.update_edit_mesh 2nd & 3rd args `loop_triangles`, `destructive`. - bmesh.types.{BMVertSeq,BMEdgeSeq,BMFaceSeq}.sort 1st & 2nd arg `key`, `reverse`. - bmesh.utils.face_split 4th..6th args `coords`, `use_exist`, `example`. - bpy.data.libraries.load 2nd..4th args `link`, `relative`, `assets_only`. - bpy.data.user_map 1st..3rd args `subset`, `key_types, `value_types`. - bpy.msgbus.subscribe_rna 5th arg `options`. - bpy.path.abspath 2nd & 3rd args `start` & `library`. - bpy.path.clean_name 2nd arg `replace`. - bpy.path.ensure_ext 3rd arg `case_sensitive`. - bpy.path.module_names 2nd arg `recursive`. - bpy.path.relpath 2nd arg `start`. - bpy.types.EditBone.transform 2nd & 3rd arg `scale`, `roll`. - bpy.types.Operator.as_keywords 1st arg `ignore`. - bpy.types.Struct.{keyframe_insert,keyframe_delete} 2nd..5th args `index`, `frame`, `group`, `options`. - bpy.types.WindowManager.popup_menu 2nd & 3rd arg `title`, `icon`. - bpy.types.WindowManager.popup_menu_pie 3rd & 4th arg `title`, `icon`. - bpy.utils.app_template_paths 1st arg `subdir`. - bpy.utils.app_template_paths 1st arg `subdir`. - bpy.utils.blend_paths 1st..3rd args `absolute`, `packed`, `local`. - bpy.utils.execfile 2nd arg `mod`. - bpy.utils.keyconfig_set 2nd arg `report`. - bpy.utils.load_scripts 1st & 2nd `reload_scripts` & `refresh_scripts`. - bpy.utils.preset_find 3rd & 4th args `display_name`, `ext`. - bpy.utils.resource_path 2nd & 3rd arg `major`, `minor`. - bpy.utils.script_paths 1st..4th args `subdir`, `user_pref`, `check_all`, `use_user`. - bpy.utils.smpte_from_frame 2nd & 3rd args `fps`, `fps_base`. - bpy.utils.smpte_from_seconds 2nd & 3rd args `fps`, `fps_base`. - bpy.utils.system_resource 2nd arg `subdir`. - bpy.utils.time_from_frame 2nd & 3rd args `fps`, `fps_base`. - bpy.utils.time_to_frame 2nd & 3rd args `fps`, `fps_base`. - bpy.utils.units.to_string 4th..6th `precision`, `split_unit`, `compatible_unit`. - bpy.utils.units.to_value 4th arg `str_ref_unit`. - bpy.utils.user_resource 2nd & 3rd args `subdir`, `create` - bpy_extras.view3d_utils.location_3d_to_region_2d 4th arg `default`. - bpy_extras.view3d_utils.region_2d_to_origin_3d 4th arg `clamp`. - gpu.offscreen.unbind 1st arg `restore`. - gpu_extras.batch.batch_for_shader 4th arg `indices`. - gpu_extras.batch.presets.draw_circle_2d 4th arg `segments`. - gpu_extras.presets.draw_circle_2d 4th arg `segments`. - imbuf.types.ImBuf.resize 2nd arg `resize`. - imbuf.write 2nd arg `filepath`. - mathutils.kdtree.KDTree.find 2nd arg `filter`. - nodeitems_utils.NodeCategory 3rd & 4th arg `descriptions`, `items`. - nodeitems_utils.NodeItem 2nd..4th args `label`, `settings`, `poll`. - nodeitems_utils.NodeItemCustom 1st & 2nd arg `poll`, `draw`. - rna_prop_ui.draw 5th arg `use_edit`. - rna_prop_ui.rna_idprop_ui_get 2nd arg `create`. - rna_prop_ui.rna_idprop_ui_prop_clear 3rd arg `remove`. - rna_prop_ui.rna_idprop_ui_prop_get 3rd arg `create`. - rna_xml.xml2rna 2nd arg `root_rna`. - rna_xml.xml_file_write 4th arg `skip_typemap`.
2021-05-30Docs: Capitalize first word of sentenceAaron Carlisle
2021-05-29PyDoc: Use em dash instead of comma for enum itemsAaron Carlisle
2021-05-17Mathutils: add a Matrix.LocRotScale constructor for combining channels.Alexander Gavrilov
Combining location, rotation and scale channels into a matrix is a standard task, so while it is easily accomplished by constructing and multiplying 3 matrices, having a standard utility allows for more clear code. The new constructor builds a 4x4 matrix from separate location, rotation and scale values. Rotation can be represented as a 3x3 Matrix, Quaternion or Euler value, while the other two inputs are vectors. Unneeded inputs can be replaced with None. Differential Revision: https://developer.blender.org/D11264
2021-05-17Merge branch 'blender-v2.93-release'Campbell Barton
2021-05-17Fix PyAPI doc generation error in 43369ca80e62aa80b951823d1c78abef58852014Campbell Barton
Files without doc-strings were not included.
2021-05-15Docs: PyAPI: Replace use of the bgl module in the RenderEngine exampleGermano Cavalcante
The bgl module will be discontinued. This example is seen at: https://docs.blender.org/api/current/bpy.types.RenderEngine.html uses it. Differential Revision: https://developer.blender.org/D11262
2021-05-12PyAPI: remove context.active_baseCampbell Barton
All other access to the Base structure from Python was removed, it seems this was left in by accident. Ref T85675
2021-05-01Docs: PyAPI: Fix css selector failing on some pagesAaron Carlisle
2021-05-01Merge branch 'blender-v2.93-release'Aaron Carlisle
2021-05-01Docs: PyAPI: Fix css selector failing on some pagesAaron Carlisle
2021-04-30Documentation: Replace the bgl API in the gpu module exemplesGermano Cavalcante
2021-04-29Merge branch 'blender-v2.93-release'Aaron Carlisle
2021-04-29Docs: PyAPI: Improve website responsiveness on narrow displaysAaron Carlisle
- Allow long enums to break early - Allow long titles to wrap - Colloapse hlist to few collumns if needed This fixes a few of the bigger issues, some more tweaks are still needed in some places
2021-04-29Docs: PyAPI: More specific css selector for long enumsAaron Carlisle
Fixes T87008
2021-04-20PyAPI: update docs to include poll_message_set referenceCampbell Barton
Part of D9738
2021-04-06Py API Docs: Update sphinx and theme versionsAaron Carlisle
2021-03-31PyDoc: quiet warning with literalinclude including blank linesCampbell Barton
Files that only contain a doc-string still included the last blank line, since this normally contains code examples. There are some cases where only a docstring exists which made sphinx report warnings.
2021-03-31PyDoc: fix indentation with multi-line property descriptionsCampbell Barton
New lines were written without indentation, causing invalid RST to be generated.
2021-03-22Cleanup: clang-format, trailing spaceCampbell Barton
Minor manual tweak to prevent wrapping an array into columns.
2021-03-01GPU Python: Implement gpu.texture.from_imageGermano Cavalcante
It can be useful to replace `image.bindcode` and `image.gl_load`. Used for example in https://docs.blender.org/api/current/gpu.html#d-image Reviewed By: brecht Differential Revision: https://developer.blender.org/D10458
2021-02-26Cleanup: commented/out of date rpdb2 importAaron Carlisle
2021-02-26PyAPI Docs: Update Sphinx to 3.5.1Aaron Carlisle
2021-02-25PyAPI Docs: Add 'gpu.state' moduleGermano Cavalcante
Also exclude `gpu.shader` from quick tests.
2021-02-25PyAPI: expose imbuf.types.ImBuf, include in API docsCampbell Barton
Without this, the ImBuf type wasn't part of documentation.
2021-02-20Python: Add to_curve method to the object APIOmar Emara
This patch adds a to_curve method to the Object ID. This method is analogous to the to_mesh method. The method can operate on curve and text objects. For text objects, the text is converted into a 3D Curve ID and that curve is returned. For curve objects, if apply_modifiers is true, the spline deform modifiers will be applied and a Curve ID with the result will be returned, otherwise a copy of the curve will be returned. The goal of this addition is to allow the developer to access the splines of text objects and to get the result of modifier applications which was otherwise not possible. Reviewed By: Brecht Differential Revision: https://developer.blender.org/D10354
2021-02-19Merge branch 'blender-v2.92-release'Aaron Carlisle
2021-02-19API Docs: Fix generation failing with unused context membersAaron Carlisle
Instead of raising an expection a warnign is generated instead. This fixes the issue where `['hair', 'pointcloud']` are disabled for release builds. In the future a better solution would be to generate the context map dynamically but this would require refactoring of the API: D9988
2021-02-19PyAPI Docs: Fix deprecation warning with new theme versionAaron Carlisle
2021-02-19Merge branch 'blender-v2.92-release'Aaron Carlisle
2021-02-19Instead of raising an expection a warnign is generated instead.Aaron Carlisle
This fixes the issue where `['hair', 'pointcloud']` are disabled for release builds. In the future a better solution would be to generate the context map dynamically but this would require refactoring of the API: D9988 Fixes T80364 Differential revision: https://developer.blender.org/D10468
2021-02-12Py Doc: Fix rst syntax errorsAaron Carlisle
2021-02-12Py Doc: Delete old deployment scriptsAaron Carlisle
Now, the API docs are deployed via the new devops pipeline developed by James.
2021-02-12Py Doc: Update Sphinx and theme versionsAaron Carlisle
2021-01-29Tests, docs: Use sanitizer options from environment too.Ankit Meel
Don't overwrite environment variables that may contain options like suppression files, symboliser etc. It's similar to rBa181b156399a13fa429159112e30c8005d5e8a59 and rBA589d13408a60cbec34a8bc3cc798c586043743ae . For Blender Add-ons repo, see the equivalent in D9816. Reviewed By: Blendify Differential Revision: https://developer.blender.org/D9815
2021-01-07PyAPI Docs: Terminal instructions for Windows incorrectAaron Carlisle
Fixes T84498
2021-01-07PyAPI Docs: Link to user docs instead of describing in API docAaron Carlisle
2021-01-07PyAPI Docs: Update Indirect Data Access docsAaron Carlisle
Fixes T84432
2021-01-07PyAPI Docs: Fix wrong modifier path usageAaron Carlisle
Fixes T84430
2021-01-07PyAPI Docs: Clarify quick start guide tipsAaron Carlisle
Some of the text here was outdated with 2.8x. See T84427
2021-01-05Fix T84388: Invalid operator reference in the quick-startCampbell Barton
2021-01-03API Docs: CSS: Fix long enum listAaron Carlisle
This commit makes some adjustments to a previous fix which broke with new versions of sphinx/theme. Fixes T76453
2020-12-08PyDoc: expanded documentation for bpy_struct.is_property_setCampbell Barton
This patch expands on the `is_property_set` doc-string, detailing the purpose of the `ghost` argument added in d3bcbe10c20e8b418659d8fdca98fd6b4bfecdfe. Reviewed By: sybren Ref D9780
2020-12-08PyDoc: avoid blank lines at the beginning of code-examplesCampbell Barton
2020-11-20Fix T82493: PyDoc generation throws exception on exitCampbell Barton
Since add-ons now unregister on exit (as of fa566157a5c351775d082b05b180c630665b4afc) clearing functions in `bpy.app.handlers` caused an error on exit. Resolve by restoring handlers before exiting.
2020-10-16Correct last commitCampbell Barton
2020-10-16PyDoc: update to account for new context memberCampbell Barton
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-05 08:40:50 +0300