diff options
author | Campbell Barton <ideasman42@gmail.com> | 2011-04-13 18:43:11 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2011-04-13 18:43:11 +0400 |
commit | 9ba543a5225977f1ef88c35c97e6315758a27d67 (patch) | |
tree | e7c1b92159511b44d0f94cd5766b66921f7c9c02 /doc/python_api/sphinx_doc_gen.py | |
parent | 5fbfbd4470876465897486c2ae3f0f8ee3375eb1 (diff) |
minor improvements to sphinx doc main page
Diffstat (limited to 'doc/python_api/sphinx_doc_gen.py')
-rw-r--r-- | doc/python_api/sphinx_doc_gen.py | 40 |
1 files changed, 24 insertions, 16 deletions
diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py index b7c9b617910..258b28a3d33 100644 --- a/doc/python_api/sphinx_doc_gen.py +++ b/doc/python_api/sphinx_doc_gen.py @@ -905,26 +905,19 @@ def rna2sphinx(BASEPATH): 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("\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("Welcome, this document is an API reference for Blender %s. built %s.\n" % (version_string, bpy.app.build_date)) fw("\n") fw("`A PDF version of this document is also available <blender_python_reference_%s.pdf>`_\n" % version_string_pdf) + + fw("\n") + + fw("============================\n") + fw("Blender/Python Documentation\n") + fw("============================\n") 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("* `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 @@ def rna2sphinx(BASEPATH): 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 |