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
Campbell Barton
28ebe827e6
Cleanup: trailing space
2020-10-02 11:59:16 +10:00
Aaron Carlisle
b150071ece
Cleanup: Python API Docs: Text formating
2020-09-28 20:11:06 -04:00
Aaron Carlisle
4d7b664e1a
API Docs: Minor text improvements
2020-09-28 20:11:06 -04:00
Max Schlecht
aead4b3cab
API Docs: Fix xref urls
...
Fully revert D7913 "Fix T77276: Generating Python API docs raises many warnings"
{D7913} broke xrefs/links to other types and permalinks in the docs. This makes the python api docs for 2.90 and 2.91 completely unusable.
It got partially reverted in commit e893430a6306ded059270e7df9d78180cdc0d9e3. That didn't fix those two issues though, so it should be fully reverted.
As you can see here, i'm not able to click `bpy_struct.id_data`, because no <a> tag got generated in the html.
{F8889934}
Here you can see a working, but wrong permalink, generated by clicking the little chain. (It should be `bpy.types.MeshVertices`, not `bpy.types.MeshVertices.MeshVertices`)
{F8889938}
Reviewed By: Blendify
Differential Revision: https://developer.blender.org/D8913
2020-09-24 23:14:15 -04:00
Bastien Montagne
211d213160
API doc: Gotcha's: Add section about abusing RNA properties callbacks.
...
Especially with new undo/redo it is even less recommended to perform
complex operations in those callbacks, they should remain as fast and
localized as possible.
Also updated the section about undo/redo a bit.
2020-09-14 11:02:52 +02:00
Aaron Carlisle
950d857505
Merge branch 'blender-v2.90-release'
2020-08-24 10:40:12 -04:00
Aaron Carlisle
9498eb2692
API Docs: Update Changelog from 2.83
2020-08-24 10:38:17 -04:00
Brecht Van Lommel
6238eabcd4
Merge branch 'blender-v2.90-release'
2020-08-12 18:50:40 +02:00
Brecht Van Lommel
54c2c14921
CMake: clarify that the modules are licensed BSD 3-Clause
...
Many of these are derived from similar modules in the CMake project, which
have this license.
Fixes T79715
2020-08-12 18:49:16 +02:00
Philipp Oeser
42f4233871
Merge branch 'blender-v2.90-release'
2020-08-05 14:10:08 +02:00
Philipp Oeser
229fe01a15
PyDoc: use glClearColor before glClear in gpu docs
...
ref T79491
Maniphest Tasks: T79491
Differential Revision: https://developer.blender.org/D8471
2020-08-05 14:09:00 +02:00
e8869d9c71
Merge remote-tracking branch 'origin/blender-v2.90-release'
2020-07-27 19:02:44 +02:00
Aaron Carlisle
e893430a63
Partly revert "Fix T77276: Generating Python API docs raises many warnings"
...
This commit reverts the "noindex" part of the original commit.
using noindex made it imposible to link to a specific property.
The original warnings do not pose an issue so until a proper solution is
found I am reverting this commit.
This reverts commit 953c232db31f1a76f99ceb43119681ce0df1ab17
2020-07-27 13:01:28 -04:00
Nathan Letwory
5a1a4f4dd2
master is now 2.91.0 alpha.
2020-07-22 16:48:29 +03:00
Campbell Barton
a197b81090
Docs: include 'bl_math' module
2020-07-22 14:36:30 +10:00
Campbell Barton
20446f07f6
Docs: reference bl_rna_get_subclass_py instead of bl_rna_get_subclass
...
bl_rna_get_subclass only works for Nodes at the moment.
2020-07-06 23:07:18 +10:00
Aaron Carlisle
b7b57e7155
PyDoc: Update Python Package Requirements
2020-06-26 13:24:53 -04:00
Aaron Carlisle
b0449cac66
API Docs: Small edits to recent commit
...
- Revert string formatting change
- Add missing text edit
2020-06-23 17:10:07 -04:00
Campbell Barton
bab2b02507
Cleanup: style, raw multi-line string sphinx updater
2020-06-23 23:32:47 +10:00
Campbell Barton
6d639a606c
Docs: quiet deprecation warning, add missing context members
2020-06-23 23:32:36 +10:00
Tobias Heinke
23f8ab4250
API docs: intro overhaul
...
- Update terminology, spelling, formatting.
- Rename screen to workspace.
- Update for 2.8 UI changes.
2020-06-23 23:13:10 +10:00
Campbell Barton
502e6bd839
Fix doc generation for enum & attr's with multi-line descriptions
2020-06-18 16:26:16 +10:00
Aaron Carlisle
953c232db3
Fix T77276: Generating Python API docs raises many warnings
2020-06-04 22:31:54 +10:00
Aaron Carlisle
2e52b3206c
PyDoc: Fix warnings from out of bounds include statement
2020-06-02 18:21:42 -04:00
Bastien Montagne
8d670546f9
Merge branch 'blender-v2.83-release'
2020-06-01 12:12:57 +02:00
Bastien Montagne
31cf87a29e
Fix py api doc gen script after recent versionning changes.
2020-06-01 12:10:56 +02:00
Brecht Van Lommel
c93a88413d
Merge branch 'blender-v2.83-release'
2020-05-29 18:05:04 +02:00
Brecht Van Lommel
a86b5df005
Blender: change bugfix release versioning from a/b/c to .1/.2/.3
...
The file subversion is no longer used in the Python API or user interface,
and is now internal to Blender.
User interface, Python API and file I/O metadata now use more consistent
formatting for version numbers. Official releases use "2.83.0", "2.83.1",
and releases under development use "2.90.0 Alpha", "2.90.0 Beta".
Some Python add-ons may need to lower the Blender version in bl_info to
(2, 83, 0) or (2, 90, 0) if they used a subversion number higher than 0.
https://wiki.blender.org/wiki/Reference/Release_Notes/2.83/Python_API#Compatibility
This change is in preparation of LTS releases, and also brings us more
in line with semantic versioning.
Fixes T76058.
Differential Revision: https://developer.blender.org/D7748
2020-05-29 17:48:26 +02:00
Aaron Carlisle
0700521833
Py Docs: Update Sphinx and Theme Dependencies
...
`sphinx_rtd_theme==0.5.0rc1` probably should not be used for 2.83 but it
would be nice to test
2020-05-24 19:23:28 -04:00
Campbell Barton
9947b1fda6
Merge branch 'blender-v2.83-release'
2020-05-12 12:53:48 +10:00
Aaron Carlisle
5852f97dc2
API Docs: Fix broken url markup
2020-05-11 21:35:33 -04:00
Campbell Barton
0e41305344
Cleanup: reference 'bpy.types.bpy_struct' directly
...
Previously there wasn't a way to access this directly from bpy.types.
2020-05-11 16:56:09 +10:00
Campbell Barton
364780bce5
Docs: list inherited C/Python API functions
2020-05-11 16:43:49 +10:00
Campbell Barton
63849aac95
Fix duplicate property references in generated API docs
2020-05-11 16:41:06 +10:00
Campbell Barton
e3673fd869
Fix building docs with sphinx 3.x
2020-05-11 16:09:56 +10:00
Campbell Barton
f4d65b0d6e
Docs: update API docs, adding reference to bl_rna_get_subclass.
2020-05-11 15:48:51 +10:00
Aaron Carlisle
904249b4f3
Doxygen: Fix warnings in Doxyfile
2020-05-08 19:53:32 -04:00
Nathan Letwory
b9ec9afce1
Bump master to 2.90 alpha for bcon1
2020-04-15 16:01:35 +03:00
Bastien Montagne
5d3c7d1218
usual PY API doc gen fix after adding a new member to Context...
2020-04-06 12:16:07 +02:00
Campbell Barton
3d3a91103b
Doc: remove MeshTessFace reference
2020-03-24 16:26:07 +11:00
Bastien Montagne
db4d264e70
fix API doc generation after new volume
entry in context...
2020-03-20 10:48:30 +01:00
Aaron Carlisle
817c38f715
PyAPI Docs: Update aud example
...
Fixes T74641
2020-03-19 16:21:17 -04:00
Aaron Carlisle
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