Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2011-04-12 16:09:38 +0400
committerCampbell Barton <ideasman42@gmail.com>2011-04-12 16:09:38 +0400
commitba03e5023ebd2d1d5db4d57a0046ce58f699d334 (patch)
tree6f3c6a11f7689fb62f5eb7673660dca47644d688 /doc
parenta42bf453335bdd569556895a168bced1fa7b3c3c (diff)
less alarming warnings about the python api not being stable in online docs and remove from interactive console.
Diffstat (limited to 'doc')
-rw-r--r--doc/python_api/sphinx_doc_gen.py18
1 files changed, 7 insertions, 11 deletions
diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py
index 2ec665180c5..57ba30ee0bb 100644
--- a/doc/python_api/sphinx_doc_gen.py
+++ b/doc/python_api/sphinx_doc_gen.py
@@ -879,8 +879,8 @@ def rna2sphinx(BASEPATH):
fw("project = 'Blender'\n")
# fw("master_doc = 'index'\n")
fw("copyright = u'Blender Foundation'\n")
- fw("version = '%s - UNSTABLE API'\n" % version_string)
- fw("release = '%s - UNSTABLE API'\n" % version_string)
+ fw("version = '%s - API'\n" % version_string)
+ fw("release = '%s - API'\n" % version_string)
fw("html_theme = 'blender-org'\n")
fw("html_theme_path = ['../']\n")
fw("html_favicon = 'favicon.ico'\n")
@@ -908,21 +908,17 @@ def rna2sphinx(BASEPATH):
fw("\n")
fw("`A PDF version of this document is also available <blender_python_reference_%s.pdf>`_\n" % version_string_fp)
fw("\n")
- fw(".. warning:: The Python API in Blender is **UNSTABLE**, It should only be used for testing, any script written now may break in future releases.\n")
+ fw(".. warning:: The Blender Python API has areas which are still in development.\n")
fw(" \n")
fw(" The following areas are subject to change.\n")
- fw(" * operator names and arguments\n")
- fw(" * render api\n")
- fw(" * function calls with the data api (any function calls with values accessed from bpy.data), including functions for importing and exporting meshes\n")
- fw(" * class registration (Operator, Panels, Menus, Headers)\n")
- fw(" * modules: bpy.props, blf)\n")
- fw(" * members in the bpy.context have to be reviewed\n")
- fw(" * python defined modal operators, especially drawing callbacks are highly experemental\n")
+ fw(" * operator behavior, names and arguments\n")
+ fw(" * mesh creation and editing functions\n")
fw(" \n")
fw(" These parts of the API are relatively stable and are unlikely to change significantly\n")
fw(" * data API, access to attributes of blender data such as mesh verts, material color, timeline frames and scene objects\n")
fw(" * user interface functions for defining buttons, creation of menus, headers, panels\n")
- fw(" * modules: bgl and mathutils\n")
+ fw(" * render engine integration\n")
+ fw(" * modules: bgl, mathutils\n")
fw(" * game engine modules\n")
fw("\n")