archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

less alarming warnings about the python api not being stable in online docs and remove from interactive console.

Browse Source
This commit is contained in:
Campbell Barton
2011-04-12 12:09:38 +00:00
parent a42bf45333
commit ba03e5023e
2 changed files with 10 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
doc/python_api/sphinx_doc_gen.py
View File

@@ -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")