From 9ba543a5225977f1ef88c35c97e6315758a27d67 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 13 Apr 2011 14:43:11 +0000 Subject: minor improvements to sphinx doc main page --- doc/python_api/sphinx_doc_gen.py | 40 ++++++++++++++++++++++++---------------- doc/python_api/sphinx_doc_gen.sh | 1 + 2 files changed, 25 insertions(+), 16 deletions(-) (limited to 'doc') 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 `_,\n") - fw("| For a more general explanation of blender/python see the `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 `_\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 `_ if you are new to scripting in blender and want to get you're feet wet!\n") + fw("* `Blender/Python 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 diff --git a/doc/python_api/sphinx_doc_gen.sh b/doc/python_api/sphinx_doc_gen.sh index 052e8072ac8..5f23ca395b6 100755 --- a/doc/python_api/sphinx_doc_gen.sh +++ b/doc/python_api/sphinx_doc_gen.sh @@ -33,6 +33,7 @@ $BLENDER --background --factory-startup --python $SPHINXBASE/sphinx_doc_gen.py # html sphinx-build $SPHINXBASE/sphinx-in $SPHINXBASE/sphinx-out + cp $SPHINXBASE/sphinx-out/contents.html $SPHINXBASE/sphinx-out/index.html ssh $SSH_USER@emo.blender.org 'rm -rf '$SSH_UPLOAD_FULL'/*' rsync --progress -avze "ssh -p 22" $SPHINXBASE/sphinx-out/* $SSH_HOST:$SSH_UPLOAD_FULL/ -- cgit v1.2.3