86622467c5
DocPy: Update Dependancies
...
Updates sphinx and the theme to the latest version along with any of their dependencies.
Note that we will be sticking to sphinx 4.1.1 until sphinx 4.2 for the same reasons listed in:
https://developer.blender.org/rBM8334
2021-08-20 13:46:38 -04:00
nutti
69fdcea978
Docs: add API docs for gpu.capabilities
...
Adds Python API documentations for gpu.capabilities module.
Ref D12226
2021-08-17 15:04:35 +10:00
nutti
d60e28093f
Docs: add API docs for gpu.platform
...
Adds Python API documentations for gpu.platform module.
Ref D12222
2021-08-17 14:45:40 +10:00
61040a36aa
PyDoc: fix for renamed context member
...
Missing change from 9cff9f9f5d
2021-08-10 17:28:09 +10:00
438d645a36
PyDoc: Update GPU Example of draw_view3d
...
This function was changed in rBc8004ab4078c98c54a70113c12bbb186403e90cf but didnt update the example.
Part of T84227
2021-08-04 20:25:50 -04:00
807bb450a0
Fix API doc generation after recent context additions
2021-07-20 22:07:41 +02:00
432bfbf7a3
Cleanup: pep8
2021-07-06 12:05:27 +10:00
c88c331384
PyDoc: Update Sphinx and pin dependencies
...
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-22 16:30:07 -04:00
f29a738e23
PyAPI: use keyword only arguments
...
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-06-09 03:05:44 +10:00
e6a69f7653
Docs: Capitalize first word of sentence
2021-05-30 11:09:01 -04:00
f5d14e36e8
PyDoc: Use em dash instead of comma for enum items
2021-05-29 12:16:13 -04:00
a86e815dd8
Mathutils: add a Matrix.LocRotScale constructor for combining channels.
...
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-17 19:12:40 +03:00
7e552b356d
Merge branch 'blender-v2.93-release'
2021-05-17 18:04:22 +10:00
e3a76feeef
Fix PyAPI doc generation error in 43369ca80e
...
Files without doc-strings were not included.
2021-05-17 18:02:56 +10:00
3c978a73d1
Docs: PyAPI: Replace use of the bgl module in the RenderEngine example
...
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-14 18:29:23 -03:00
44db4e50b2
PyAPI: remove context.active_base
...
All other access to the Base structure from Python was removed,
it seems this was left in by accident.
Ref T85675
2021-05-12 22:02:18 +10:00
37e16e3589
Docs: PyAPI: Fix css selector failing on some pages
2021-05-01 01:54:05 -04:00
d540a858d8
Merge branch 'blender-v2.93-release'
2021-05-01 01:53:34 -04:00
f11a3c36e3
Docs: PyAPI: Fix css selector failing on some pages
2021-05-01 01:28:31 -04:00
c3a980436d
Documentation: Replace the bgl API in the gpu module exemples
2021-04-30 10:50:50 -03:00
14f59a0349
Merge branch 'blender-v2.93-release'
2021-04-28 18:27:47 -04:00
48bbeaf383
Docs: PyAPI: Improve website responsiveness on narrow displays
...
- 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-28 18:25:47 -04:00
a71d8ecb69
Docs: PyAPI: More specific css selector for long enums
...
Fixes T87008
2021-04-28 17:57:58 -04:00
7ccd19fc12
PyAPI: update docs to include poll_message_set reference
...
Part of D9738
2021-04-20 12:29:04 +10:00
074b0b6da0
Py API Docs: Update sphinx and theme versions
2021-04-05 17:28:36 -04:00
43369ca80e
PyDoc: quiet warning with literalinclude including blank lines
...
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-31 17:47:31 +11:00
d5f2043ab3
PyDoc: fix indentation with multi-line property descriptions
...
New lines were written without indentation,
causing invalid RST to be generated.
2021-03-31 17:43:30 +11:00
544b3ab1de
Cleanup: clang-format, trailing space
...
Minor manual tweak to prevent wrapping an array into columns.
2021-03-22 14:25:42 +11:00
Germano Cavalcante
6c6b1c015c
GPU Python: Implement gpu.texture.from_image
...
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-03-01 17:38:57 -03:00
b1b9671c93
Cleanup: commented/out of date rpdb2 import
2021-02-25 18:27:57 -05:00
fbb0017c90
PyAPI Docs: Update Sphinx to 3.5.1
2021-02-25 17:51:48 -05:00
cccdd6626d
PyAPI Docs: Add 'gpu.state' module
...
Also exclude `gpu.shader` from quick tests.
2021-02-25 09:16:48 -03:00
c47990f41c
PyAPI: expose imbuf.types.ImBuf, include in API docs
...
Without this, the ImBuf type wasn't part of documentation.
2021-02-25 12:04:23 +11:00
f2c0bbed1c
Python: Add to_curve method to the object API
...
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-20 18:05:13 +02:00
cb3e092d45
Merge branch 'blender-v2.92-release'
2021-02-19 02:00:56 -05:00
241273d362
API Docs: Fix generation failing with unused context members
...
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-19 01:58:16 -05:00
7266d8e32a
PyAPI Docs: Fix deprecation warning with new theme version
2021-02-18 23:55:23 -05:00
f75f447ce8
Merge branch 'blender-v2.92-release'
2021-02-18 22:54:22 -05:00
e6acc4db72
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
Fixes T80364
Differential revision: https://developer.blender.org/D10468
2021-02-18 22:51:24 -05:00
97072e0135
Py Doc: Fix rst syntax errors
2021-02-12 13:14:43 -05:00
95cba37190
Py Doc: Delete old deployment scripts
...
Now, the API docs are deployed via the new devops pipeline developed by
James.
2021-02-12 13:14:43 -05:00
432b758ae3
Py Doc: Update Sphinx and theme versions
2021-02-12 13:14:43 -05:00
27e2c5ab78
Tests, docs: Use sanitizer options from environment too.
...
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-29 14:13:26 +05:30
5530d6f86f
PyAPI Docs: Terminal instructions for Windows incorrect
...
Fixes T84498
2021-01-07 15:58:47 -05:00
27426c05b1
PyAPI Docs: Link to user docs instead of describing in API doc
2021-01-06 19:52:13 -05:00
b138c8f5b3
PyAPI Docs: Update Indirect Data Access docs
...
Fixes T84432
2021-01-06 19:34:21 -05:00
a9c607e60e
PyAPI Docs: Fix wrong modifier path usage
...
Fixes T84430
2021-01-06 18:54:56 -05:00
133bdac306
PyAPI Docs: Clarify quick start guide tips
...
Some of the text here was outdated with 2.8x.
See T84427
2021-01-06 18:45:34 -05:00
a0db43cd7b
Fix T84388: Invalid operator reference in the quick-start
2021-01-05 15:51:50 +11:00
1e8f266591
API Docs: CSS: Fix long enum list
...
This commit makes some adjustments to a previous fix which broke with
new versions of sphinx/theme.
Fixes T76453
2021-01-02 20:04:25 -05:00
