document some of the pitfalls in the blender python api (taken from frequent mails and bug reports)

2011-08-26 04:00:55 +00:00
parent 566da26173
commit e9ca846018
2 changed files with 293 additions and 0 deletions
--- a/doc/python_api/sphinx_doc_gen.py
+++ b/doc/python_api/sphinx_doc_gen.py
@@ -103,6 +103,7 @@ sphinx-build doc/python_api/sphinx-in doc/python_api/sphinx-out
 INFO_DOCS = (
    ("info_quickstart.rst", "Blender/Python Quickstart: new to blender/scripting and want to get you're feet wet?"),
    ("info_overview.rst", "Blender/Python API Overview: a more complete explanation of python integration"),
+    ("info_gotcha.rst", "Gotcha's: some of the problems you may come up against when writing scripts"),
    )

 # import rpdb2; rpdb2.start_embedded_debugger('test')