griefith/test2
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
25,161 Commits 1 Branch 0 Tags
930f2fa89848c60efd2a2083bad36ff7c98369dd
Commit Graph

39 Commits

Author SHA1 Message Date
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
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
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
Campbell Barton
c3ab6bc509 rna reference docs, list inherited properties and functions at the bottom of each type. 2010-04-09 20:43:58 +00:00
Campbell Barton
bad41fcff5 - new docstrings for bpy.type.Struct methods & some corrections. 
- struct.path_to_id() --> path_from_id().
 2010-04-06 07:49:10 +00:00
Campbell Barton
e302f33be7 document bpy.types.Struct methods C methods, currently only keyframe_delete() and keyframe_insert() have useful docstrings. 
http://www.blender.org/documentation/250PythonDoc/bpy.types.Struct.html?highlight=bpy.types.struct#bpy.types.Struct.keyframe_insert
 2010-04-05 22:37:09 +00:00
Tamito Kajiyama
f85bcac8ae Added an entry for the documentation of the Freestyle Python API. 
Also fixed a minor bug in sphinx_doc_gen.py that raised a TypeError
when a C extension function does not have a docstring.
 2010-04-05 21:06:32 +00:00
Campbell Barton
391cc2d004 merge own commits into render branch into trunk since 27560 
27562, 27570, 27571, 27574, 27576, 27577, 27579, 27590, 27591, 27594, 27595, 27596, 27599, 27605, 27611, 27612, 27613, 27614, 27623
 2010-03-20 16:41:01 +00:00
Campbell Barton
d975351f51 parts of the Python API are unstable, big discalmer in API docs main page, API Docs title and interactive console banner. 2010-03-01 10:34:54 +00:00
Campbell Barton
ed7f4f2e3c make BGL and BLF modile names lowercase 2010-02-28 14:57:26 +00:00
Campbell Barton
c1cd33e166 examples for autogenerated docs are now implicit and used when available. 
This means adding the file "bpy.props.py" in the examples dir will automatically be used when generating docs, unused examples give warnings.
 2010-02-28 13:45:08 +00:00
Campbell Barton
fc1cb1670e include BLF in automated doc generation 
http://www.blender.org/documentation/250PythonDoc/BLF.html
 2010-02-28 11:54:48 +00:00
Campbell Barton
768f20d537 update for missing docs & dont include operator classes in sphinx docs. 2010-02-16 15:01:34 +00:00
Campbell Barton
081c1205a3 correct fsf address 2010-02-12 13:34:04 +00:00
Campbell Barton
fd3842f3a2 Mathutils doc improvements + other small things 
- bpy.app moved into PyStructSequence (used by sys.float_info)
- added buildinfo into bpy.app.build_*
- bpy.ui removed (wasnt used)
- include external example files in Mathutils docs (only Mathutils and Vector are currently written)
- added support to auto document PyStructSequence's
- CMake had "'s inside all its strings.
 2010-01-31 21:52:26 +00:00