From 5585b3e9084a96f54c5b75479a492b504252351b Mon Sep 17 00:00:00 2001 From: Dalai Felinto Date: Mon, 23 Jan 2012 19:53:23 +0000 Subject: rst bge touch ups: making the title of the examples slightly more noticeable - it's still not correct, comparing to the other examples, but at least it looks okish. - fixed some small typos --- doc/python_api/examples/bge.constraints.py | 2 +- doc/python_api/examples/bge.texture.1.py | 4 ++-- doc/python_api/examples/bge.texture.py | 2 +- doc/python_api/rst/bge.constraints.rst | 5 +++++ doc/python_api/rst/bge.texture.rst | 10 ++++++++++ doc/python_api/rst/bge.types.rst | 2 +- 6 files changed, 20 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/python_api/examples/bge.constraints.py b/doc/python_api/examples/bge.constraints.py index de2f7e0a39d..e76fc3dd13b 100644 --- a/doc/python_api/examples/bge.constraints.py +++ b/doc/python_api/examples/bge.constraints.py @@ -1,6 +1,6 @@ """ Basic Physics Constraint -++++++++++++++++++++++ +++++++++++++++++++++++++ Example of how to create a hinge Physics Constraint between two objects. """ from bge import logic diff --git a/doc/python_api/examples/bge.texture.1.py b/doc/python_api/examples/bge.texture.1.py index 918ffc9772d..fba369739f7 100644 --- a/doc/python_api/examples/bge.texture.1.py +++ b/doc/python_api/examples/bge.texture.1.py @@ -1,6 +1,6 @@ """ -Texture replacement -++++++++++++++++++++++ +Texture Replacement ++++++++++++++++++++ Example of how to replace a texture in game with an external image. createTexture() and removeTexture() are to be called from a module Python Controller. diff --git a/doc/python_api/examples/bge.texture.py b/doc/python_api/examples/bge.texture.py index 70e4d6d9377..1ba0b99fc27 100644 --- a/doc/python_api/examples/bge.texture.py +++ b/doc/python_api/examples/bge.texture.py @@ -1,6 +1,6 @@ """ Basic Video Playback -++++++++++++++++++++++ +++++++++++++++++++++ Example of how to replace a texture in game with a video. It needs to run everyframe """ import bge diff --git a/doc/python_api/rst/bge.constraints.rst b/doc/python_api/rst/bge.constraints.rst index da0a358dfed..83f2a6b4950 100644 --- a/doc/python_api/rst/bge.constraints.rst +++ b/doc/python_api/rst/bge.constraints.rst @@ -5,6 +5,11 @@ Physics Constraints (bge.constraints) .. module:: bge.constraints .. literalinclude:: ../examples/bge.constraints.py + :language: rest + :lines: 2-4 + +.. literalinclude:: ../examples/bge.constraints.py + :lines: 6- .. function:: createConstraint(physicsid, physicsid2, constrainttype, [pivotX, pivotY, pivotZ, [axisX, axisY, axisZ, [flag]]]]) diff --git a/doc/python_api/rst/bge.texture.rst b/doc/python_api/rst/bge.texture.rst index 0abefcbea82..07d83f66bd4 100644 --- a/doc/python_api/rst/bge.texture.rst +++ b/doc/python_api/rst/bge.texture.rst @@ -37,8 +37,18 @@ When the texture object is deleted, the new texture is deleted and the old textu .. module:: bge.texture .. literalinclude:: ../examples/bge.texture.py + :language: rest + :lines: 2-4 + +.. literalinclude:: ../examples/bge.texture.py + :lines: 6- + +.. literalinclude:: ../examples/bge.texture.1.py + :language: rest + :lines: 2-6 .. literalinclude:: ../examples/bge.texture.1.py + :lines: 8- .. class:: VideoFFmpeg(file [, capture=-1, rate=25.0, width=0, height=0]) diff --git a/doc/python_api/rst/bge.types.rst b/doc/python_api/rst/bge.types.rst index 6988f90cc1e..735ad037175 100644 --- a/doc/python_api/rst/bge.types.rst +++ b/doc/python_api/rst/bge.types.rst @@ -954,7 +954,7 @@ Game Types (bge.types) .. deprecated:: use :data:`localPosition` and :data:`worldPosition`. - :type: :class:`mathurils.Vector` + :type: :class:`mathutils.Vector` .. attribute:: orientation -- cgit v1.2.3