Commit Graph

933 Commits

Author SHA1 Message Date
233d8594fc [#26768] 2.57 - sys.path not initialized properly
we should document this properly (we only have general design docs atm), for now just correct the tooltip.

also update api example docs.
2011-04-04 05:47:04 +00:00
3ddbb36fa7 modification to api docs so release point to:
http://www.blender.org/documentation/blender_python_api_2_57b_release

Development versions point to:
   http://www.blender.org/documentation/blender_python_api_2_57_0

This way updates to api docs after release wont overwrite release docs.
2011-04-01 15:13:58 +00:00
d4a9bc1c21 while looking into adding back brush tool keys found mixed texture/image paint rna vars, using 'image paint' internally. 2011-04-01 04:22:30 +00:00
2900557568 examples for keyframing nested paths. based on report from user der_On's report [#25746] 2011-03-31 12:45:54 +00:00
50a06eccff pep8 cleanup 2011-03-27 05:23:14 +00:00
04e32be958 optparse module is deprecated, use new argparse module in background job template.
correction to example in doc too.
2011-03-26 03:42:59 +00:00
1b80538fea fix [#25688] undocumted functions in pyapi
expose collection function docs.
2011-03-22 04:28:51 +00:00
35dae4f0b5 add sphinx api reference note that menu's layout.operator_context defaults to EXEC_REGION_WIN rather then INVOKE_DEFAULT. 2011-03-17 22:49:46 +00:00
2d1ef275f2 bpy.types.libraries.load sphinx doc & examples (doc system needed some updates).
http://www.blender.org/documentation/blender_python_api_2_56_3/bpy.types.BlendDataLibraries.html#bpy.types.BlendDataLibraries.load
2011-03-14 10:31:50 +00:00
bc15e0e295 add NDEBUG to scons release flags + some pep8 cleanup for examples. 2011-02-25 16:19:50 +00:00
dd8383e469 make doc generation close files (py3.2 complains about this),
minor formatting changes for C docstrings.
2011-02-22 05:23:20 +00:00
93d562b7b6 correct example 2011-02-22 04:42:21 +00:00
e46da7166b remove BGE's PyObjectPlus.isA method docs, was removed in favor of built-in isinstance(), report [#26080]. 2011-02-21 10:15:19 +00:00
24d7606cb8 SVN maintenance. 2011-02-18 19:33:19 +00:00
251d27110b examples for bpy.props 2011-02-18 14:27:18 +00:00
5531f3093a render engine example thanks to dougal2. 2011-02-18 13:40:13 +00:00
063a7f217b python api docs & examples for registrable Menu/Panel/Operator/PropertyGroup classes. 2011-02-18 08:47:37 +00:00
aed7eaf0d9 sphinx doc gen: multiple examples possible and include the scripts docstring inline in sphinx.
also tag unused vars
2011-02-16 17:31:04 +00:00
7748860aeb doc generation support for excluding some modules, without this a full rebuild takes too long to test changes.
also include own function definitions for blf_dir.c.
2011-02-16 05:18:10 +00:00
fee5363912 bugfix [#26094] Going to Bone Roll menu brings up python error
also correct for pep8 warnings.
2011-02-16 02:25:03 +00:00
cb12d708c7 Doc generator now makes 'bpy.context' api reference.
http://www.blender.org/documentation/250PythonDoc/bpy.context.html

strings are extracted from blender to ensure all values are included, currently there is no type info so this is stored in the doc generator.
2011-02-15 15:37:40 +00:00
1cdab667bc - cmake was missing an inclide (IDE's wouldnt index)
- made doc generation always sumlink newly built docs to static URL. http://www.blender.org/documentation/250PythonDoc/
2011-02-06 10:18:20 +00:00
998198a041 mathutils rotate functions for Euler/Quaternion/Matrix/Vector types.
each accept Euler/Quaternion/Matrix types.

eg:
  Euler.rotate(Quaternion(axis, angle))
  Vector.rotate(Euler((pi/2, 0, 0)))

matrix.resize_4x4() and euler.make_compatible() were still returning an instance of themselves, now return None.
2011-02-05 09:57:02 +00:00
736a7b7a22 pep8 cleanup 2011-02-04 09:27:25 +00:00
ce7f7d6e5f r34526 removed a line which had an unused return value but still needed to run. 2011-01-27 12:36:48 +00:00
577e3b435e removing epydocs for mathutils and geometry mododules (now they are in sphinx) 2011-01-01 23:53:48 +00:00
54343b79e6 remove reload() from builtins since python3 no longer uses this.
use imp.reload now.

Should use import hooks but for now replace imp.reload with our own reload as the builtin reload was replaced before.
2010-12-22 21:39:48 +00:00
b4081bfc7b patch [#25027] formatting mathutils.geometry module docs for sphinx
from Luka Bonavita

See:
http://www.blender.org/documentation/250PythonDoc/mathutils.geometry.html
2010-12-10 00:20:32 +00:00
25bd57b0a1 include getset's for generating module docs.
used for bpy.debug/tempdir/driver_namespace which were previously undocumented.
2010-12-06 12:36:55 +00:00
56f8ced34f == console ==
- banner formatting

== sphinx doc ==

- bpy.data: put the example below the documentation itself
2010-11-25 14:55:03 +00:00
2777ba74b0 remove include paths which dont exist, fix for doc upload script which was getting the blender version twice and not working sometimes. 2010-10-27 13:52:12 +00:00
3264ced377 move geometry python module into mathutils.geometry, since it provides utility functions using mathutils types. 2010-10-25 22:44:01 +00:00
996efebbe3 == python api doc ==
First commit to make some structure in doc/ directory.

- moved source/blender/python/doc -> doc/python_api
- moved source/gameengine/PyDoc/*.rst -> doc/python_api/rst
- modified accordingly sphinx_doc_gen.py and sphinx_doc_gen.sh
  (later on I'll try alternative/ scripts by neXyon as promised :)
- source/gameengine/PyDoc/ is still there because contains epydoc stuff for the bge, will ask more and look into it later
2010-10-13 10:42:33 +00:00