Campbell Barton
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
Aaron Carlisle
b1b9671c93
Cleanup: commented/out of date rpdb2 import
2021-02-25 18:27:57 -05:00
Aaron Carlisle
fbb0017c90
PyAPI Docs: Update Sphinx to 3.5.1
2021-02-25 17:51:48 -05:00
Germano Cavalcante
cccdd6626d
PyAPI Docs: Add 'gpu.state' module
...
Also exclude `gpu.shader` from quick tests.
2021-02-25 09:16:48 -03:00
Campbell Barton
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
Omar Emara
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
Aaron Carlisle
cb3e092d45
Merge branch 'blender-v2.92-release'
2021-02-19 02:00:56 -05:00
Aaron Carlisle
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
Aaron Carlisle
7266d8e32a
PyAPI Docs: Fix deprecation warning with new theme version
2021-02-18 23:55:23 -05:00
Aaron Carlisle
f75f447ce8
Merge branch 'blender-v2.92-release'
2021-02-18 22:54:22 -05:00
Aaron Carlisle
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
Aaron Carlisle
97072e0135
Py Doc: Fix rst syntax errors
2021-02-12 13:14:43 -05:00
Aaron Carlisle
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
Aaron Carlisle
432b758ae3
Py Doc: Update Sphinx and theme versions
2021-02-12 13:14:43 -05:00
Ankit Meel
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
Aaron Carlisle
5530d6f86f
PyAPI Docs: Terminal instructions for Windows incorrect
...
Fixes T84498
2021-01-07 15:58:47 -05:00
Aaron Carlisle
27426c05b1
PyAPI Docs: Link to user docs instead of describing in API doc
2021-01-06 19:52:13 -05:00
Aaron Carlisle
b138c8f5b3
PyAPI Docs: Update Indirect Data Access docs
...
Fixes T84432
2021-01-06 19:34:21 -05:00
Aaron Carlisle
a9c607e60e
PyAPI Docs: Fix wrong modifier path usage
...
Fixes T84430
2021-01-06 18:54:56 -05:00
Aaron Carlisle
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
Campbell Barton
a0db43cd7b
Fix T84388: Invalid operator reference in the quick-start
2021-01-05 15:51:50 +11:00
Aaron Carlisle
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
Campbell Barton
78080337f8
PyDoc: expanded documentation for bpy_struct.is_property_set
...
This patch expands on the `is_property_set` doc-string,
detailing the purpose of the `ghost` argument added in
d3bcbe10c2 .
Reviewed By: sybren
Ref D9780
2020-12-08 20:52:31 +11:00
Campbell Barton
28169cea3d
PyDoc: avoid blank lines at the beginning of code-examples
2020-12-08 20:49:28 +11:00
Campbell Barton
07db110add
Fix T82493: PyDoc generation throws exception on exit
...
Since add-ons now unregister on exit
(as of fa566157a5 )
clearing functions in `bpy.app.handlers` caused an error on exit.
Resolve by restoring handlers before exiting.
2020-11-20 18:59:59 +11:00
Campbell Barton
5d92fd8a90
Correct last commit
2020-10-16 20:51:58 +11:00
Campbell Barton
b002fdc4bf
PyDoc: update to account for new context member
2020-10-16 20:29:55 +11:00
Aaron Carlisle
4fa4245464
PyDocs: GPU Module: Examples: convert all gl_FragColor variables to FragColor
...
Based on D6425 by @robbott
Differential Revision: https://developer.blender.org/D6425
2020-10-14 11:18:36 -04:00
Aaron Carlisle
cf778a9e42
Pydoc: BGL: update links
2020-10-11 20:14:16 -04:00
Aaron Carlisle
df3d124e91
Pydoc: Fix bpy.utils submodule showing in main toctree
2020-10-11 18:38:55 -04:00
Aaron Carlisle
72335d5e89
Pydoc: Move builtin GPU shader information to code
...
This fixes a compile warning for sphinx.
This commit includes some reformating of the information.
2020-10-11 18:21:28 -04:00
Aaron Carlisle
e8a2931299
Pydoc: Cleanup: Rename function
...
The new name makes more sense as the file is called index and we are not
writing the contents of all rst files
2020-10-11 17:02:41 -04:00
Aaron Carlisle
a38c2dcfe6
Pydoc: Add index and genindex to main index
2020-10-11 16:54:52 -04:00
Aaron Carlisle
c95ab2c6f0
Pydoc: Remove old note about new module in 2.65
2020-10-11 16:46:21 -04:00
Aaron Carlisle
fbcb26fb33
Pydoc: Add submodule heading to submodule lists
2020-10-11 16:09:42 -04:00
Aaron Carlisle
f735491b9f
PyDoc: Set max width to 1000px
...
While not full width this gives a nice trade off between improved screen
use space and readibility.
The old value was 80 so this gives 25% more screen space.
See T73223
2020-10-08 21:37:28 -04:00
Campbell Barton
decb3b10aa
Cleanup: operator execution types didn't read well on one line
2020-10-09 12:14:22 +11:00
Campbell Barton
05710171cb
PyDoc: resolve duplicate module warnings
...
Remove submodule listings from the module docstring,
as this information already exists in the generator.
2020-10-09 12:11:00 +11:00
Aaron Carlisle
fb20efae59
PyDoc: fix most of the sphinx-build warnings
...
Use `.. currentmodule::` instead of `.. module::` for `bpy.types` and
`bpy.ops`. This change fixes most of the errors.
Ref D9139
2020-10-08 16:27:42 +11:00
Campbell Barton
0b4aeffda9
PyDoc: support building without sphinx_rtd_theme
...
This is no longer bundled with sphinx, support building without it.
2020-10-08 12:32:50 +11:00
Campbell Barton
05d637280c
Fix recent update to sphinx_doc_gen.sh
...
2f1a0f6f0e copied Makefile syntax into a
shell script. Use sphinx-builds 'auto' command to set the number of
jobs to run.
2020-10-08 11:08:36 +11:00
Aaron Carlisle
c4a281e801
PyDoc: Use explicit class names to refence class
...
This fixes the link and makes it more clear which class the note is
talking about
2020-10-07 17:25:19 -04:00
Aaron Carlisle
d88da4db67
PyDoc: Render in text class name using class link syntax
2020-10-07 17:00:57 -04:00
Aaron Carlisle
021b94f27c
PyDoc: Fix sphinx warnign from missing newline
2020-10-07 15:51:29 -04:00
Aaron Carlisle
2f1a0f6f0e
PyDoc: Multithread sphinx-build
...
Compile times went from over 5min to under 2 on my laptop.
2020-10-07 10:25:46 -04:00
Aaron Carlisle
e748abda92
PyDoc: Remove workaround for slow sphinx builds
...
Tesing with newer versions of sphinx to directory `sphinx-build` is
executed has no affect on the build time. Testing even gave a 2-3% speed
boost.
2020-10-07 10:25:46 -04:00
Aaron Carlisle
7951312d4b
API Doc Gen: Do not ignore objects file
...
This is used by the Blender manual or other sphinx website that would
like to link to Blender's API documentation.
2020-10-05 16:26:40 -04:00
Campbell Barton
41d2d6da0c
Cleanup: pep8 (indentation, spacing, long lines)
2020-10-02 11:59:16 +10:00
Campbell Barton
bab9de2a52
Cleanup: pep8, blank lines
2020-10-02 11:59:16 +10:00