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
AgeCommit message (Collapse)Author
2022-06-06PyDocs: remove sphinx-intlAaron Carlisle
Cop paste mistake from rB3cd283a424ec92ef85e1856d66f0baa4d2253fc5
2022-06-06Py Docs: Update Sphinx and dependenciesAaron Carlisle
- Adds python 3.10 support - Slightly improves performance
2022-06-02Cleanup: remove "<pep8 compliant>" from headersCampbell Barton
It can be assumed that all scripts comply with basic pep8 formatting regarding white-space, indentation etc. Also remove note in best practices page & update `tests/python/pep8.py`. If we want to exclude some scripts from make format, this can be done by adding them to `ignore_files` in: source/tools/utils_maintenance/autopep8_format_paths.py Or using `# nopep8` for to ignore for individual lines. Ref T98554
2022-06-02PyDoc: changes to the generated conf.py fileCampbell Barton
- Set the highlight language to python3 (excludes python2 syntax). - Set the encoding for code highlighting to utf-8 (no need to detect). - Update deprecated variable name. - Remove redundant unicode prefixed string.
2022-06-02PyDoc: remove CSS override for scrolling long enum listsCampbell Barton
Adding a scroll-bar to in-line lists has the down-side that it cuts of text including warnings or notes that can be included, see: T87008. Now enums are referenced [0] this is no longer needed, reverting [1]. [0]: 1c6b66c9cf80b3c9b4542b27948ae232f930a211 [1]: 1e8f2665916c049748a3985a2fce736701925095
2022-06-01Cleanup: minor changes to sphinx_doc_genCampbell Barton
- Remove unused pymethod2sphinx. - Correct exception string formatting. - Define encoding for file reading with execfile(..).
2022-05-31PyDoc: replace in-lined enum references with links where possibleCampbell Barton
Avoid in-lining large enums such as icons and event types, linking to them instead. This mitigates T76453, where long enums took a lot of space in the docs, this was a problem with `UILayout` where each icon argument would list all icons. [0] worked around the issue using CSS to scroll the list. However this has the draw-back where some items are clipped in a way that's not obvious, see: T87008. The reason this isn't a complete solution is that Python defined enums aren't written into their own pages which can be linked to, although currently there are no large Python enums included in the API docs. All in-lined enums are now under 20 items. [0]: 1e8f2665916c049748a3985a2fce736701925095
2022-05-31PyDoc: document static enums from RNA_enum_items.hCampbell Barton
Create a page for every enum in RNA_enum_items.h, which includes the enum values and the doc-string for each item. Each page creates a references which the API reference can be linked to via the same name as the enum, so :ref:`rna_enum_icon_items` links to the list of icons for e.g. This has two main advantages: - No need to manually duplicate enum values in the doc-strings of functions defined in Python's C/API (not RNA defined functions), `bpy.props` for example. - The generated Python API docs can reference these instead of including the enums in-line - resulting in unreasonably long lists in the case if icons and event types (for example). These changes will be made separately.
2022-05-25PyDoc: suppress duplicate object description warningCampbell Barton
RenderEngine.render is both a method and an attribute, while this should be avoided it's not causing a problem in practice so quiet the warning when generating docs. Sphinx now builds docs without any warnings.
2022-05-23PyDoc: quiet output and minor cleanupCampbell Barton
Suppress printing unnecessary output when generating docs.
2022-05-23Fix error in sphinx_doc_gen.py when loggingCampbell Barton
Regression in 45ed325443a3a3afb57da25ad01d636a94bf6cee
2022-05-22PyDoc: resolve/quiet warnings for pylintCampbell Barton
- Duplicate keys in dict. - Redefining names. - Unused arguments. - Use lazy % formatting in logging functions.
2022-05-22PyDoc: cleanup doc-generatorCampbell Barton
- Full sentences for comments. - Use double quotes for strings (which aren't enum ID's). - Reduce right-shift.
2022-05-20Merge branch 'blender-v3.2-release'Campbell Barton
2022-05-19Python API: warn that the bgl module is deprecated in the docsBrecht Van Lommel
This was already mentioned in the release notes but not the API docs. Ref T80730
2022-05-18Merge branch 'blender-v3.2-release'Campbell Barton
2022-05-18Fix T88792: WindowManager.clipboard missing in Python API docsCampbell Barton
Support RNA types using the Py/C-API PyGetSetDef defined properties. Currently `WindowManager.clipboard` is the only instance of this.
2022-05-18Cleanup: remove unused variables, redundant assignmentsCampbell Barton
2022-05-18PyDoc: support building full API docs on macOS & WIN32Campbell Barton
Accessing context members depended on `ctypes` to access symbols which were hidden for macOS & WIN32. Add an API call that doesn't require the symbols to be exported. This allows most symbols to be hidden on Linux, see D14971.
2022-05-18Cleanup: formatCampbell Barton
2022-05-11Cleanup: formatCampbell Barton
2022-05-09EEVEE & Viewport: Add a built-in shader called 3D_IMAGE, and expose to the ↵Shashank Shekhar
python API Adds an example python script to the documentation for the 3D_IMAGE shader. The **use-case** is to draw textures with 3D vertex positions, in XR views as well as non-XR views (in a simpler manner). **Testing**: I've tested that this compiles and works on my Macbook (with the example python script included in this change). I don't have access to a Windows or Linux machine right now, but this change doesn't look platform-specific and no new glsl shaders have been added or edited by this change. I'll try to get access to a Windows machine, but if someone does have one, I'd be really grateful if they could try this change. Thanks! **Problem addressed**: The existing 2D_IMAGE shader (exposed in the python API) gets near-clipped when drawn in the XR view, regardless of the near-clip settings. Additionally, the 2D_IMAGE shader only accepts 2D positions for the image vertices, which means drawing textures in 3D requires providing 2D coordinates and then pushing a transform-rotate-scale matrix to the GPU, even for non-XR (i.e. WINDOW) views. The 3D_IMAGE shader is simpler: it accepts 3D vertex positions, and doesn't require any additional work by the scripter. **Workaround**: The current workaround is to use custom shaders in the python script. **Non-intrusive change**: No new glsl shaders were added. This change just bundles two existing shaders: the vertex shader used by the 3D_IMAGE_MODULATE_ALPHA shader, and the fragment shader used by the 2D_IMAGE shader. Reviewed By: #eevee_viewport, jbakker Differential Revision: https://developer.blender.org/D14832
2022-05-06Merge branch 'blender-v3.2-release'Bastien Montagne
2022-05-06Add documentation about Image/ImBuf to python/RNA API.Bastien Montagne
Related to T95616, the relationship between Image ID and ImBuf 'cached' buffers can be fairly confusing when using the RNA API. Reviewed By: campbellbarton, jbakker Differential Revision: https://developer.blender.org/D14833
2022-05-03Merge branch 'blender-v3.2-release'Campbell Barton
2022-05-03Cleanup: use context.temp_overrideCampbell Barton
Remove use of deprecated operator context passing. Also minor clarification in the context.temp_override docs.
2022-05-02Blender 3.3 bcon1 - alphaThomas Dinges
Bump the version number for the new release cycle.
2022-04-26Cleanup: autopep8Campbell Barton
2022-04-20Cleanup: re-run autopep8 with E401 enabledCampbell Barton
Put imports on their own line which was almost always the case already.
2022-04-20Cleanup: run autopep8 with max-line-length=120Campbell Barton
2022-04-20Cleanup: run autopep8 on doc/Campbell Barton
2022-04-20Docs: update examples to use Context.temp_overrideCampbell Barton
2022-04-20PyAPI: temporary context override supportCampbell Barton
Support a way to temporarily override the context from Python. - Added method `Context.temp_override` context manager. - Special support for windowing variables "window", "area" and "region", other context members such as "active_object". - Nesting context overrides is supported. - Previous windowing members are restored when the context exists unless they have been removed. - Overriding context members by passing a dictionary into operators in `bpy.ops` has been deprecated and warns when used. This allows the window in a newly loaded file to be used, see: T92464 Reviewed by: mont29 Ref D13126
2022-04-19PyDoc: quiet warnings for duplicate members bpy.contextCampbell Barton
2022-04-19PyDoc: fix including literal text immediately after function argsCampbell Barton
Literal text from examples could be included directly after function arguments, this caused a warning with mis-matching indentation.
2022-04-19Cleanup: Use correct capitalization of "F-Curve"Aaron Carlisle
2022-04-06API doc: Tweak sphinx to get date of source commit instead of build date.Bastien Montagne
This commit disables the 'last updated' value (which is the date the sphinx doc is generated), and instead modifies the 'commit' field from the 'html_context' data to get: - a link to the commit itself. - the date of that commit. This avoids having the whole documentation detected as changed every time it is re-generated by the buildbot. Reviewed By: dfelinto, campbellbarton Differential Revision: https://developer.blender.org/D14429
2022-04-06Doxygen: update doxyfile to 1.9.3Campbell Barton
Resolves deprecation warnings.
2022-03-30Cleanup: use equality instead of contains for single-item setsCampbell Barton
2022-03-18Docs: add license text file for LGPL2.1Campbell Barton
2022-03-04Cleanup: unused Python variables & importsCampbell Barton
2022-02-22Merge branch 'blender-v3.1-release'Aaron Carlisle
2022-02-22Python API Docs: Hide version swtichAaron Carlisle
This still needs some fixes to be ready for release.
2022-02-14GNUmakefile: update arguments for 'doc_man' targetCampbell Barton
Add '--verbose' argument to the script so the destination is printed. Otherwise there is no hint to where the man page was written.
2022-02-11Docs: add license text files for all SPDX identifiersBrecht Van Lommel
2022-02-11License: add GPL-3.0-or-later identifierCampbell Barton
Some add-ons use this.
2022-02-11File headers: manually convert files to use SPDX headersCampbell Barton
Also add BSD-2-Clause to SPDX license list.
2022-02-11File headers: add missing copyright, add MIT to SPDX licensesCampbell Barton
2022-02-11File headers: use SPDX for Zlib licenseCampbell Barton
2022-02-11Cleanup: remove white-space before headersCampbell Barton