Tamito Kajiyama
4fae911383
Merged changes in the trunk up to revision 31440.
2010-08-18 13:16:34 +00:00
Campbell Barton
fab0f053e7
syntax highlighting for decorators, correct doc example
2010-08-17 14:56:10 +00:00
Campbell Barton
b278279c95
document rna functions that have the no_self flag set as classmethods
2010-08-17 14:32:14 +00:00
Campbell Barton
7a31417f50
apply UserPrefs and Theme rna naming changes.
2010-08-17 13:14:41 +00:00
Tamito Kajiyama
92478de0eb
Merged changes in the trunk up to revision 31403.
2010-08-17 07:10:03 +00:00
Joerg Mueller
78d96324ae
Py API Docs (GSoC): Third merging commit
...
* Added the alternative docs system with templating functionality
* Added aud to sdg.py
2010-08-16 12:22:19 +00:00
Joerg Mueller
47d38dbd20
svn merge -r 31211:31313 https://svn.blender.org/svnroot/bf-blender/trunk/blender
2010-08-13 10:50:29 +00:00
Tamito Kajiyama
1a875f915d
Merged changes in the trunk up to revision 31284.
2010-08-12 13:41:59 +00:00
Campbell Barton
aae5c9b58d
- possibly bugfix /w uninitialized vars [ #23270 ] Long directory name segmentation fault in File brower.
...
- in exceptional cases vertcos_to_key() could return with KeyBlock pointing to freed memory.
- invalid use of realloc() in BLI_builddir()
2010-08-11 22:36:43 +00:00
Campbell Barton
6cae52bca2
add support for documenting class methods
2010-08-11 17:13:39 +00:00
Tamito Kajiyama
dd75ec4907
Merged changes in the trunk up to revision 31190.
2010-08-09 11:32:55 +00:00
Joerg Mueller
64b36ffbb3
svn merge -r 31060:31144 https://svn.blender.org/svnroot/bf-blender/trunk/blender
2010-08-07 15:45:07 +00:00
Campbell Barton
30d180ff0d
bugfix [ #23194 ] export UVs miss the extension file
...
also made all other exporters do this.
Made some internal changes.
- moved path functions from bpy.utils to bpy.path (similar to os.path)
- added functions...
bpy.path.ensure_ext(path, ".ext", case_sensitive=False) # simple function to ensure the extension is set.
bpy.path.resolve_ncase(path) # useful for importing scenes made on windows where the path case doesnt match the files.
2010-08-06 01:40:54 +00:00
Joerg Mueller
46155bc009
svn merge -r 30513:30565 https://svn.blender.org/svnroot/bf-blender/trunk/blender
2010-07-21 07:24:52 +00:00
Tamito Kajiyama
e423e085f8
Merged changes in the trunk up to revision 30551.
2010-07-20 19:39:07 +00:00
Campbell Barton
75410037fd
- correct some spelling errors.
...
- remove FreeCamera struct (wasnt used)
- remove world color alpha values (not used anywhre).
2010-07-20 10:41:08 +00:00
Joerg Mueller
1f7bcf2544
Minor sphinx corrections:
...
* Attributes starting with _ in classes are now ignored
* sphinx.blend updated so that it doesn't have to be edited anymore if the script changes
2010-07-19 13:36:10 +00:00
Joerg Mueller
8ecf072f9a
BGE Py API:
...
* Sphinx autorun file.
* bge modules are now autogenerated
* added aud module
2010-07-16 21:42:20 +00:00
Tamito Kajiyama
2df7f76e78
Merged changes in the trunk up to revision 30397.
2010-07-15 21:05:11 +00:00
Campbell Barton
5daf9354d2
change some references to .B.blend, .Blog to new names
2010-07-15 11:51:43 +00:00
Tamito Kajiyama
f588c49cb5
Merged changes in the trunk up to revision 30335.
2010-07-14 19:01:40 +00:00
Campbell Barton
8e3a9634a3
Change to text3d: When back or front is enabled, the bevel rim on the other side is not created anymore, just as the back/front filling faces are not created when disabled.
...
when both are off the behavior is unchanged.
This is needed when rendering alpha text so its possible to have a single layer of faces but use the bevel option to make text thicker.
adding a rim on the back when back is disabled also doesnt make much sense IMHO.
minor python edits too.
2010-07-14 17:47:58 +00:00
Campbell Barton
148ccc2f17
bugfix [ #22800 ] Mathutil bug with vector
...
example wasnt updated.
2010-07-11 16:12:32 +00:00
Tamito Kajiyama
b8de9bc5fb
Merged changes in the trunk up to revision 29994.
2010-07-05 18:37:29 +00:00
Luca Bonavita
1a6b9ea5d9
== python api docs ==
...
- properties are now listed on alphabetical order
- readonly properties use "data" directive, so that we see them in green in the web docs
example (after Campbell will rebuild the docs):
http://www.blender.org/documentation/250PythonDoc/bpy.types.RenderLayer.html
(note that green attributes still need final CSS-ing, but smerch is a bit busy atm)
- fixed indentation in http://www.blender.org/documentation/250PythonDoc/bpy.data.html
2010-06-28 00:06:23 +00:00
Campbell Barton
768ecb1ba9
api reference docs: include bpy.data in the main page since its used everywhere.
...
since this isnt a module its self its a little odd to do this but toctree cant make arbitrary cross-references.
Also added some usage examples: http://www.blender.org/documentation/250PythonDoc/bpy.data.html
2010-06-27 18:34:27 +00:00
Tamito Kajiyama
cb805085ef
Merged changes in the trunk up to revision 29702.
2010-06-26 13:39:43 +00:00
Martin Poirier
5ed7699e85
mathutils.RotationMatrix
...
Angles are in radians. Doc and example should reflect reality
2010-06-23 02:42:39 +00:00
Tamito Kajiyama
4d141cf808
Merged changes in the trunk up to revision 29550.
2010-06-18 22:53:49 +00:00
Luca Bonavita
22bca493b2
== addons ==
...
- release/scripts/ui/space_userpref.py
added the change to add a 'warning' field to bl_addon_info
warning icons are used to show 'broken' scripts or warnings
asked permission to campbell and matt in blendercoders to apply this
- source/blender/python/doc/sphinx_doc_gen.py:
small fix in the url
2010-06-17 02:38:49 +00:00
Campbell Barton
927aac74ab
- module for reading blend start/end frames and scene name (useful for finding the total frame count without loading a blend file)
...
- added render api as unstable to the docs.
2010-06-15 12:06:30 +00:00
Luca Bonavita
8d3a5a8b0a
== python api docs ==
...
* source/blender/python/doc/sphinx_doc_gen.py:
changed the "undocumented" message so that it still links to
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute
but uses flags in the url to help documenting.
Example: http://www.blender.org/documentation/250PythonDoc/bpy.ops.node.html#bpy.ops.node.link
click on "contribute", the new section has title "bpy.ops.node.link" and a howto message is shown
* source/blender/python/intern/bpy.c:
fixed a typo
2010-06-15 02:06:01 +00:00
Luca Bonavita
dba99b544b
== python api docs ==
...
* source/gameengine/PyDoc/bge.types.rst:
KX_PolygonMaterial was missing the parent class indication (PyObjectPlus)
* source/blender/python/doc/sphinx_doc_gen.py:
* unified all the "undocumented" descriptions, like
http://www.blender.org/documentation/250PythonDoc/bpy.ops.anim.html#bpy.ops.anim.keyframe_delete_button
so that it will be easy for Alex to CCS 'em and also now people will have a link to contribute descriptions,
see http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute
* moved the note about bpy_struct not being available in the api
in a proper note directive, so that it's more evident
(I didn't see it at first)
2010-06-11 22:41:13 +00:00
Tamito Kajiyama
df0b629e24
Merged changes in the trunk up to revision 29409.
2010-06-11 17:17:02 +00:00
Luca Bonavita
677a0434a4
== python api docs ==
...
- small change to indicate the source file we use the proper :file: directive and we link to proper file in svn
check for example http://www.blender.org/documentation/250PythonDoc/bpy.ops.cloth.html#bpy.ops.cloth.preset_add
after you rebuild the docs
2010-06-04 13:47:56 +00:00
Tamito Kajiyama
ca6f7ddd99
Merged changes in the trunk up to revision 29184.
2010-06-03 15:39:02 +00:00
Luca Bonavita
e58bb562d2
== python api docs ==
...
* source/blender/python/doc/sphinx_doc_gen.py
changed syntax for declating attributes type to use :type: instead of *type* os it
* source/gameengine/Ketsji/KX_PythonInit.cpp
While documenting I've found that we have two naming conventions for constraints in BGE python api,
example: KX_CONSTRAINTACT_DIRPZ and KX_ACT_CONSTRAINT_FHPX: the right convention is KX_CONSTRAINTACT_xxx
After talking with dalai and cambpell we agreed that this kind of change is better suited for NExyon GSoC
so I marked as TODO
Also, found 2 duplicate rows, fixed after askin nexyon
* source/gameengine/PyDoc/bge.logic.rst
there were 2 blocks for constraints, I've put them together in docs and fixed some other lines
* source/gameengine/PyDoc/bge.types.rst
first cleanup: mainly started using ":type:", it was mixed usage of *type* and **type**
started cleaning some bullet list in a way that varibles link to the constant in appropriate page
I'll continue later
2010-06-02 21:28:17 +00:00
Alex Sytnik
286f167845
== Sphinx Doc Gen ==
...
Workaround to address attribute description issue.
In resulting .rst file attribute's descriptions appeared
not indented which sphinx considered as anoter blocks.
2010-05-30 00:24:32 +00:00
Tamito Kajiyama
dbcb73c033
Merged changes in the trunk up to revision 28911.
2010-05-21 22:01:47 +00:00
Campbell Barton
45444ceee3
include game engine docs in sphinx doc generation:
...
bge.events, logic, render & types (others still need work)
Updated http://www.blender.org/documentation/250PythonDoc
2010-05-17 20:38:54 +00:00
Tamito Kajiyama
cfc351afee
Merged changes in the trunk up to revision 28772.
2010-05-14 21:50:15 +00:00
Campbell Barton
c598d90899
Sphinx theme from Alex Sytnik (smerch) for API Docs
...
You wouldnt know its not blender.org :D
http://www.blender.org/documentation/250PythonDoc/mathutils.html
from revision 39 of https://svn.blender.org/svnroot/blend-doc/trunk/python/doc
2010-05-14 10:21:57 +00:00
Campbell Barton
6d8cb93f71
building docs failed when the output directory didnt alredy exist.
2010-05-09 17:18:57 +00:00
Tamito Kajiyama
8a20433f0f
Merged changes in the trunk up to revision 28600.
2010-05-05 22:57:58 +00:00
Campbell Barton
914d5e5f62
sphinx doc generation
...
- include default values as well as min/max.
- partial rebuilds, so we dont have to build all docs each time, only the changed files.
2010-05-03 15:52:15 +00:00
Tamito Kajiyama
dfe2f8dc03
Merged changes in the trunk up to revision 28247.
2010-04-18 02:03:19 +00:00
Tamito Kajiyama
11fc330f7e
Fix for including docstrings of static methods.
2010-04-13 00:55:37 +00:00
Campbell Barton
67cfc427ee
PyAPI
...
- added new mathutils.Color() type, use with rna so we can do for eg:
material.diffuse_color.r = 1.0
# also has hsv access
material.diffuse_color.s = 0.6
- made Mathutils and Geometry module names lowercase.
2010-04-11 14:22:27 +00:00
Campbell Barton
9eb838ce24
bpy.app was writing members more then once.
2010-04-10 19:06:18 +00:00
Campbell Barton
6e3920e8fa
rna/py/reference doc improvements..
...
- vectors now respect min/max settings.
- keyframing and adding drivers raises an error in an index is set on a non array, keyframing raises an error if it fails.
reference docs...
- added docstrings for remaining python bpy_struct functions
- added fake class for docs, bpy_struct, which is the base class of everything in bpy.types
- improved inherictance references for struct classes, include bpy_struct members.
2010-04-10 18:35:50 +00:00