db4d264e70
fix API doc generation after new volume entry in context...
2020-03-20 10:48:30 +01:00
817c38f715
PyAPI Docs: Update aud example
...
Fixes T74641
2020-03-19 16:21:17 -04:00
7177862313
API Docs: Point to manual for Operator Cheat Sheet
2020-03-06 12:50:19 -05:00
2d5773d11a
Documentation: added bpy.msgbus description and examples
...
The `bpy.msgbus` namespace was not included in the documentation generation.
I've added it, and ported Campbell's examples from P563.
2020-03-06 14:29:03 +01:00
Aaron Carlisle
ae223ff52b
Addons: deprecate 'wiki_url'
...
When running with debug enabled ('-d' argument),
warnings are printed for add-ons which are not yet updated.
Reminder to name things based on what they do,
not the technologies they use :)
2020-03-05 11:45:22 +11:00
dc257318d0
PyAPI Doc: Add missing Imbuf documentantion
...
The documentation existed but it was never added to the script.
2020-02-25 23:17:01 -05:00
Ian Karanja
73e404697b
Fix small typo in BGL API docs
...
Differential Revision: https://developer.blender.org/D6681
2020-02-14 17:59:00 +01:00
be8879718e
Documentation: add note on altering data from frame change handlers
...
Blender can crash while rendering, when scene data is changed from within
a `frame_change_pre` or `frame_change_post` callback function. This results
in bug reports like T60094, T67627, and T73530. Until this is properly
resolved, this limitation should be documented.
No functional changes.
2020-02-11 11:00:12 +01:00
7d6c08beb8
Doc: simplify T72883 fix
...
Code example made it seem setting the active object was more complex
than a single assignment.
2020-02-11 11:27:01 +11:00
189e96ba68
Fix T72883: Correct Context Usage
2020-02-10 14:08:34 -05:00
379ee3e527
PY API doc generation: Add option for multi-tasking sphinx.
2020-02-10 12:38:03 +01:00
2ab5ca81a5
Fix T68413: gpu module example in docs produces unexpected results
2020-01-27 10:29:00 -03:00
12b183ba55
Docs: update reference to PYTHONPATH
2020-01-25 20:15:38 +11:00
dfa3f51e52
Fix (unreported) broken PY API doc gen after recent GP changes.
...
As usual... Adding/removing members from context requires updates of the
API building script.
2020-01-13 15:58:05 +01:00
50b478e328
Fix Py API doc generation after Mantaflow merge.
2019-12-23 15:19:03 +01:00
eb798de101
Clean/Fix remaining cases of props assignments in resgistrable structs def.
...
We still had a few deprecated assignements of `bpy.props.xxx` to class
members in our API documentation and one of our py tests. Annotations
are to be used now.
Also remove the section about `register_module` utils, this has been
removed in 2.8.
Fix T71877: Python API overview sample code warning: class MyMaterialProps contains a property which should be an annotation!
Fix T71876: Python API overview references old bpy.utils.register_module function
2019-11-27 12:19:10 +01:00
dc9b05df22
Fix API docs build after recent changes in BMesh operators.
...
Note: not sure what 'type' to give for that new
`BMO_OP_SLOT_SUBTYPE_PTR_STRUCT`, name sounds generic so used
`bpy_struct` for now... :/
2019-11-25 12:33:51 +01:00
0384cc6f78
API Docs: don't show functions in 'bpy.app.handlers'
...
This shows the function and it's memory location,
it's not useful for docs so remove it.
2019-11-16 02:41:17 +11:00
4ca87085e0
API Docs: only document built-in types
...
Some types were documented in bpy.types aren't accessible there.
For now, disable documenting types from add-ons and some types from
bl_operators, bl_ui... since these are mostly for internal use.
2019-11-16 02:39:51 +11:00
61bf51acb5
Cleanup: pep8 for examples
2019-11-01 10:53:47 +11:00
879d269e87
Py API doc generator: more tweaks to adapt to new release process.
...
Now we also create a 'version' symlink for master.
2019-10-14 18:46:50 +02:00
15539f7b6d
Py API doc generator: tweak to handle new release process.
...
We need to handle beta stage in a specific way, since it's no longer
master, but not yet 'real' rc/release stage...
For now, only point to version dir of the API doc, but no need to create
any symlink (that way, 'current' remain pointing to 2.80 release, while
'2.81' is no longer a symlink to 'master', but its own actual doc).
2019-10-14 17:39:17 +02:00
7137d1470a
Docs: update link
2019-09-13 07:46:25 +10:00
c8c3e7d284
Cleanup: trailing space, remove tabs, pep8
2019-09-10 06:17:59 +10:00
5e77fb2482
API Docs: Correct Hotkey
...
Here we can link to the manual and keep the hotkey updated in the manual
rather than the API docs.
Fixes T68371
2019-08-07 17:20:40 -04:00
604fdb6e85
Spelling fixes in comments and descriptions, patch by luzpaz
...
Differential Revision: https://developer.blender.org/D3744
2019-07-31 14:27:35 +02:00
52cf94eeb5
API Docs: Change handling of Blender Version
2019-07-08 20:53:15 -04:00
75d48c6efd
API Docs: Hide Home Icon in Seach Area
2019-07-08 20:53:15 -04:00
9a0a952f72
API Docs: Fix file name
2019-07-08 11:45:25 -04:00
313097c267
API Docs: Fix Links
2019-07-06 19:46:05 -04:00
e1fbab12dc
API Docs: Update Changlog for 2.80
2019-07-06 17:01:11 -04:00
8933a3bbd0
API Docs: Fix Update changelog script to python3
2019-07-06 17:01:11 -04:00
1f2f5f660b
API Docs: Use Opensearch
2019-07-06 17:01:11 -04:00
f702830a79
API Docs: Theme: Prevent Super Long Enums
2019-07-06 17:01:10 -04:00
6fad70d551
Cleanup: API Doc Gen: move copying static dir to own function
2019-07-06 17:01:10 -04:00
669d50f803
Fix T66405: Python API documentation
...
removed glVertex from the Python bgl api documentation as they are
deprecated.
2019-07-04 09:19:48 +02:00
d2788510fb
API Docs: Update Build Dependencies
2019-07-03 22:47:44 -04:00
66a69fa220
API Docs: Theme Options
...
- Limit Nav depth to 1
- Turn off stick nav
- Add canonical_url
2019-07-03 22:46:52 -04:00
74ffcad90e
PyAPI Doc: Fix presets menu example.
2019-06-26 15:35:34 +02:00
0e327968a9
PyAPI Doc: Minor updates to UIList examples...
2019-06-26 15:06:18 +02:00
52b4afacb2
Fix errors raised at generating Python API docs
...
D5121 by @Nutti
2019-06-24 20:07:20 +10:00
0c538fc923
Cleanup: spelling, grammar, and other corrections
...
D5084 by @nBurn with edits
2019-06-21 10:18:53 +10:00
3a7af37e28
Python API Docs: fix some examples
2019-06-06 17:13:02 +02:00
33e8db94b1
Fix (unreported) missing updates in scripts/docs after scene.update() removal.
...
This should really have been done together with API changes, simple
usage of grep does the trick to catch most places needing updates.
2019-06-04 14:39:51 +02:00
351e68e0a4
Docs: update quick-start
...
Resolves T64146
2019-06-04 13:12:59 +10:00
Dalai Felinto
c01e43d024
Update Python GPU example to latest depsgraph API
2019-05-31 11:31:04 -03:00
1885d234b0
Fix (unreported) API doc generation script after removal of some ObjectBase ietms from context.
2019-05-27 16:06:40 +02:00
Dalai Felinto
caf52e3779
Update "Overriding Context" API example
2019-05-24 19:21:30 -03:00
49593a2c38
Fix T64528: error in RenderEngine API docs example
2019-05-23 10:33:11 +02:00
8022bd7059
Depsgraph examples: don't assign to names of built-in Python objects
...
`object` is the superclass of all objects. Old-style code could still be
using `class SomeClass(object)` and assigning something else to `object`
could have unexpected results.
This is now also documented in the
[Python style guide](https://wiki.blender.org/wiki/Style_Guide/Python )
on the wiki.
Differential Revision: https://developer.blender.org/D4922
Reviewed by: sergey
2019-05-23 10:29:49 +02:00
