[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [36150] trunk/blender/doc/python_api/ sphinx_doc_gen.py: ack, wrong file in previous commit, this one has doc changes.
Campbell Barton
ideasman42 at gmail.com
Wed Apr 13 16:43:42 CEST 2011
Revision: 36150
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=36150
Author: campbellbarton
Date: 2011-04-13 14:43:41 +0000 (Wed, 13 Apr 2011)
Log Message:
-----------
ack, wrong file in previous commit, this one has doc changes.
Modified Paths:
--------------
trunk/blender/doc/python_api/sphinx_doc_gen.py
Modified: trunk/blender/doc/python_api/sphinx_doc_gen.py
===================================================================
--- trunk/blender/doc/python_api/sphinx_doc_gen.py 2011-04-13 14:43:11 UTC (rev 36149)
+++ trunk/blender/doc/python_api/sphinx_doc_gen.py 2011-04-13 14:43:41 UTC (rev 36150)
@@ -905,26 +905,19 @@
fw(" Blender Documentation contents\n")
fw("%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\n")
fw("\n")
- fw("This document is an API reference for Blender %s. built %s.\n" % (version_string, bpy.app.build_date))
+ fw("Welcome, this document is an API reference for Blender %s. built %s.\n" % (version_string, bpy.app.build_date))
fw("\n")
- fw("| An introduction to Blender and Python can be found at `Quickstart Intro <http://wiki.blender.org/index.php/Dev:2.5/Py/API/Intro>`_,\n")
- fw("| For a more general explanation of blender/python see the `API Overview <http://wiki.blender.org/index.php/Dev:2.5/Py/API/Overview>`_\n")
- fw("\n")
fw("`A PDF version of this document is also available <blender_python_reference_%s.pdf>`_\n" % version_string_pdf)
+
fw("\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 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(" * render engine integration\n")
- fw(" * modules: bgl, mathutils\n")
- fw(" * game engine modules\n")
+
+ fw("============================\n")
+ fw("Blender/Python Documentation\n")
+ fw("============================\n")
fw("\n")
+ fw("\n")
+ fw("* `Quickstart Intro <http://wiki.blender.org/index.php/Dev:2.5/Py/API/Intro>`_ if you are new to scripting in blender and want to get you're feet wet!\n")
+ fw("* `Blender/Python Overview <http://wiki.blender.org/index.php/Dev:2.5/Py/API/Overview>`_ for a more complete explanation of python integration in blender\n")
fw("===================\n")
fw("Application Modules\n")
@@ -993,6 +986,21 @@
fw(" :maxdepth: 1\n\n")
fw(" change_log.rst\n\n")
+ fw("\n")
+ fw("\n")
+ fw(".. note:: 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 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(" * render engine integration\n")
+ fw(" * modules: bgl, mathutils & game engine.\n")
+ fw("\n")
+
file.close()
# internal modules
More information about the Bf-blender-cvs
mailing list