Campbell Barton
50a9454e0f
move wiki api intro and overview docs into the api reference docs.
...
Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
Campbell Barton
75a63981cd
add warning about misuse of ID.user_clear() since it can crash blender.
2011-08-23 11:28:18 +00:00
Campbell Barton
f4293067c1
py api: sphinx doc corrections, pep8 cleanup and style edits, also added __all__ to some modules which were missing it.
2011-07-31 03:15:37 +00:00
Campbell Barton
6aae2698ac
patch [ #27885 ] bge.constraints documentation
...
by Solano Felicio (solano)
2011-07-08 02:59:25 +00:00
Campbell Barton
af27622a87
some corrections to bge.texture docs
2011-07-07 19:23:51 +00:00
Campbell Barton
01550f880e
add 'bgl' OpenGL doc to sphinx
2011-07-01 11:16:42 +00:00
Campbell Barton
69ff819a2e
print the help message if running from python directly.
2011-06-27 04:50:08 +00:00
Campbell Barton
a9dd90be78
move load_image into image_utils and add some docstrings to bpy_extras module.
2011-05-28 09:34:45 +00:00
Campbell Barton
ecf2d1ff4e
- generate sphinx docs for bpy_extras module
...
- add in support to doc generator for automatically generating docs for submodules.
2011-05-28 07:47:58 +00:00
Campbell Barton
05a78baa87
sphinx api docs: fix for addons linking to the wrong operator SVN url's.
...
also change from blender from 'release' back to beta so new docs don't overwrite the 2.57b release docs.
2011-05-05 14:45:24 +00:00
Campbell Barton
9ba543a522
minor improvements to sphinx doc main page
2011-04-13 14:43:11 +00:00
Campbell Barton
2ed8b5f679
reference the release PDF correctly
2011-04-12 16:56:15 +00:00
Campbell Barton
ba03e5023e
less alarming warnings about the python api not being stable in online docs and remove from interactive console.
2011-04-12 12:09:38 +00:00
Campbell Barton
24b012c978
Sphinx RNA API changelog generator.
...
- lists added and removed functions and properties.
- lists renamed properties (does fuzzy comparison using min/max, description, type)
- lists functions with arguments changed.
Committed change log from 2.56 -> 2.57:
http://www.blender.org/documentation/250PythonDoc/change_log.html
2011-04-07 07:53:28 +00:00
Campbell Barton
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
Campbell Barton
2900557568
examples for keyframing nested paths. based on report from user der_On's report [ #25746 ]
2011-03-31 12:45:54 +00:00
Campbell Barton
50a06eccff
pep8 cleanup
2011-03-27 05:23:14 +00:00
Campbell Barton
1b80538fea
fix [ #25688 ] undocumted functions in pyapi
...
expose collection function docs.
2011-03-22 04:28:51 +00:00
Campbell Barton
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
Campbell Barton
bc15e0e295
add NDEBUG to scons release flags + some pep8 cleanup for examples.
2011-02-25 16:19:50 +00:00
Campbell Barton
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
Campbell Barton
251d27110b
examples for bpy.props
2011-02-18 14:27:18 +00:00
Campbell Barton
063a7f217b
python api docs & examples for registrable Menu/Panel/Operator/PropertyGroup classes.
2011-02-18 08:47:37 +00:00
Campbell Barton
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
Campbell Barton
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
Campbell Barton
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
Campbell Barton
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
Campbell Barton
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
Campbell Barton
736a7b7a22
pep8 cleanup
2011-02-04 09:27:25 +00:00
Campbell Barton
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
Campbell Barton
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
Campbell Barton
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
Luca Bonavita
56f8ced34f
== console ==
...
- banner formatting
== sphinx doc ==
- bpy.data: put the example below the documentation itself
2010-11-25 14:55:03 +00:00
Campbell Barton
3264ced377
move geometry python module into mathutils.geometry, since it provides utility functions using mathutils types.
2010-10-25 22:44:01 +00:00
Luca Bonavita
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
