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/sphinx_doc_gen.py
AgeCommit message (Collapse)Author
2022-04-20Cleanup: run autopep8 with max-line-length=120Campbell Barton
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-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-02-11File headers: SPDX License migrationCampbell Barton
Use a shorter/simpler license convention, stops the header taking so much space. Follow the SPDX license specification: https://spdx.org/licenses - C/C++/objc/objc++ - Python - Shell Scripts - CMake, GNUmakefile While most of the source tree has been included - `./extern/` was left out. - `./intern/cycles` & `./intern/atomic` are also excluded because they use different header conventions. doc/license/SPDX-license-identifiers.txt has been added to list SPDX all used identifiers. See P2788 for the script that automated these edits. Reviewed By: brecht, mont29, sergey Ref D14069
2022-02-11Fix: Missing changes in recent "Curves" renameHans Goudey
More missing changes in fe1816f67fbc6aaf3. This will hopefully fix a Python API docs build error, and fixes the "Object Types Visibility" popover.
2022-02-03Py Docs: Fix typo in previous commitAaron Carlisle
- Correct spacing - Add missing comma
2022-02-03Py Docs: Implement version switch to switch between versions on the websiteAaron Carlisle
This commit adds a version switch similar to the one on the user manual, in the future it would be nice to refactor both of these into a more generic code that works for both. Maybe develop this into a sphinx extension. As part of this change I had to change how the blender hash is displayed. Instead of the version hash in the top left it has been moved to the page footer. This change will also be backported to 2.93 LTS, 2.93 LTS, and 3.0.
2022-01-19PyAPI Docs: Prepare for Sphinx 4.5Aaron Carlisle
2021-12-07Docs: Incorrect link to context typeAaron Carlisle
Fixes T93773
2021-11-24Context: add accessors returning selected actions for animation editors.Alexander Gavrilov
Add a new 'selected_visible_actions' property to allow querying actions that are selected in animation related editors for use in UI and operators. The 'selected_editable_actions' variant excludes linked actions (the only reason an action can be read-only). In the Action and Shape Key editors there is only one action that is specified by the field at the top of the editor. In Dope Sheet it scans the channel rows and returns all actions related to the selected items. This includes summary items for actions and groups. In Graph Editor, it lists actions associated with selected curves. The new property is also used for Copy To Selected and Alt-Click. Ref D11803
2021-11-08Cleanup: Grammar in commentsHans Goudey
2021-10-28Python doc generator: add missing `selected_ids` context keySybren A. Stüvel
Add the context key I introduced in rB03c0581c6ed to the Python API docs generator. No functional changes to Blender.
2021-10-28Python doc generator: raise explanatory error when context key is missingSybren A. Stüvel
When a new key is added to the context, it also needs to be added to the `sphinx_doc_gen.py` file for generating the Python API documentation. When this isn't done, the script would raise a generic `KeyError`. Now it explains what needs to be updated to solve the problem. No functional changes to Blender.
2021-10-27Fix broken Python API doc generation after addition of selected_idsBrecht Van Lommel
2021-10-20Tracking: support editing all selected tracksPhilipp Oeser
This patch adds a "selected_movieclip_tracks" context member and enables editing properties of multiple selected tracks via the usual Alt-click editing (as well as the "Copy To Selected" operator). Both use UI_context_copy_to_selected_list() to gather a list of other selected items [which are now taken via said new context member]. Strictly speaking, this could be done without the context member as well [just gathering other selected tracks in UI_context_copy_to_selected_list() without relying on a context member], but this might come in handy in other places (e.g. Addons). note: some could be desired for markers (e.g. editing pattern/search areas of all selected track markers, but since this is burried in a uiTemplate, this is a bit more work for another patch). Differential Revision: https://developer.blender.org/D12923
2021-10-04Asset Browser: Support dragging assets into catalogsJulian Eisel
With this it is possible to select any number of assets in the Asset Browser and drag them into catalogs. The assets will be moved to that catalog then. However, this will only work in the "Current File" asset library, since that is the only library that allows changing assets, which is what's done here. While dragging assets over the tree row, a tooltip is shown explaining what's going to happen. In preparation to this, the new UI tree-view API was already extended with custom drop support, see 4ee2d9df428d. ---- Changes here to the `wmDrag` code were needed to support dragging multiple assets. Some of it is considered temporary because a) a proper #AssetHandle design should replace some ugly parts of this patch and b) the multi-item support in `wmDrag` isn't that great yet. The entire API will have to be written anyway (see D4071). Maniphest Tasks: T91573 Differential Revision: https://developer.blender.org/D12713 Reviewed by: Sybren Stüvel
2021-09-01BPY-Docs: Add missing file context members documentationJulian Eisel
Context members of the file space would not be shown in the context API docs.
2021-08-31Context: add "active_nla_track" & "active_nla_strip" context membersCampbell Barton
Selection was already accessible but not active. Add utility functions: - ANIM_nla_context_track to access the active track, following the convention of ANIM_nla_context_strip. - ANIM_nla_context_*_ptr versions of these functions, needed to for creating context members to access the ID pointer. Part of fix for T90723.
2021-08-31PyDoc: Fix compilation after recent contex_member additionAaron Carlisle
Fixes missing change needed for rB0a8f53a7b847d9c8bdcefc025de70fd2608012b7
2021-08-30Docs: retitle 'GPU Shader Module' to 'GPU Module'Germano Cavalcante
We already have a module for GPU Shader (`gpu.shader`). So, remove the name "Shader" from the title to avoid confusion.
2021-08-17Docs: add API docs for gpu.capabilitiesnutti
Adds Python API documentations for gpu.capabilities module. Ref D12226
2021-08-17Docs: add API docs for gpu.platformnutti
Adds Python API documentations for gpu.platform module. Ref D12222
2021-08-10PyDoc: fix for renamed context memberCampbell Barton
Missing change from 9cff9f9f5df034ca27848875c25471dd952c34c4.
2021-07-20Fix API doc generation after recent context additionsJulian Eisel
2021-05-30Docs: Capitalize first word of sentenceAaron Carlisle
2021-05-29PyDoc: Use em dash instead of comma for enum itemsAaron Carlisle
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-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-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-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-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-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-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
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
2020-10-12Pydoc: Fix bpy.utils submodule showing in main toctreeAaron Carlisle
2020-10-12Pydoc: Cleanup: Rename functionAaron Carlisle
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-11Pydoc: Add index and genindex to main indexAaron Carlisle
2020-10-11Pydoc: Add submodule heading to submodule listsAaron Carlisle
2020-10-09PyDoc: resolve duplicate module warningsCampbell Barton
Remove submodule listings from the module docstring, as this information already exists in the generator.
2020-10-08PyDoc: fix most of the sphinx-build warningsAaron Carlisle
Use `.. currentmodule::` instead of `.. module::` for `bpy.types` and `bpy.ops`. This change fixes most of the errors. Ref D9139
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-30 11:41:07 +0300