Commit Graph

5 Commits

Author SHA1 Message Date
f5951ac2ea == python api docs ==
- now that I've made syntax changes in the previous commit I moved blocks to to have sensors/actuators grouped together
- added sections to have a nice table of contents
- formatted 2 lists and links to classes
2010-06-02 22:56:08 +00:00
e58bb562d2 == python api docs ==
*  source/blender/python/doc/sphinx_doc_gen.py
	
	changed syntax for declating attributes type to use :type: instead of *type* os it

* source/gameengine/Ketsji/KX_PythonInit.cpp

	While documenting I've found that we have two naming conventions for constraints in BGE python api,
	example: KX_CONSTRAINTACT_DIRPZ and KX_ACT_CONSTRAINT_FHPX: the right convention is KX_CONSTRAINTACT_xxx
	After talking with dalai and cambpell we agreed that this kind of change is better suited for NExyon GSoC
	so I marked as TODO
	
	Also, found 2 duplicate rows, fixed after askin nexyon

* source/gameengine/PyDoc/bge.logic.rst

	there were 2 blocks for constraints, I've put them together in docs and fixed some other lines
	
* source/gameengine/PyDoc/bge.types.rst

	first cleanup: mainly started using ":type:", it was mixed usage of *type* and **type**
	started cleaning some bullet list in a way that varibles link to the constant in appropriate page
	I'll continue later
2010-06-02 21:28:17 +00:00
6b918fb86f = Game Engine PyDocs =
Document's headers trailing dots removed, to make them consistent with other docs.
2010-05-28 19:59:15 +00:00
45444ceee3 include game engine docs in sphinx doc generation:
bge.events, logic, render & types (others still need work)

Updated http://www.blender.org/documentation/250PythonDoc
2010-05-17 20:38:54 +00:00
3a12668e92 epydoc to sphinx markup for GameLogic module 2010-05-17 19:52:25 +00:00