Skip to content
This repository has been archived by the owner on Sep 25, 2022. It is now read-only.

Commit

Permalink
updated some attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
nickdelgrosso committed Jan 16, 2018
1 parent d6c200c commit 63af363
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 31 deletions.
14 changes: 7 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@
import os
from mock import Mock as MagicMock

class Mock(MagicMock):
@classmethod
def __getattr__(cls, name):
return Mock()

MOCK_MODULES = ['argparse', 'numpy', 'pyglet', 'pyglet.gl', '_transformations']
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
# class Mock(MagicMock):
# @classmethod
# def __getattr__(cls, name):
# return Mock()
#
# MOCK_MODULES = ['argparse', 'numpy', 'pyglet', 'pyglet.gl', '_transformations']
# sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down
7 changes: 0 additions & 7 deletions docs/ratcave.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,6 @@ ratcave.mesh module
:undoc-members: EmptyMesh
:show-inheritance:

ratcave.mixins module
---------------------

.. automodule:: ratcave.mixins
:members:
:undoc-members:
:show-inheritance:

ratcave.resources module
------------------------
Expand Down
15 changes: 0 additions & 15 deletions docs/ratcave.utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,6 @@ ratcave.utils.gl module
:undoc-members:
:show-inheritance:

ratcave.utils.orienting module
------------------------------

.. automodule:: ratcave.utils.orienting
:members:
:undoc-members:
:show-inheritance:

ratcave.utils.timers module
---------------------------

.. automodule:: ratcave.utils.timers
:members:
:undoc-members:
:show-inheritance:


Module contents
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Tutorial 1: Displaying a 3D Object

This tutorial will show the process of displaying a 3D object onscreen. This will be done in four steps:
- We'll open a file containing 3D objects--a Wavefront .obj file containing basic 3D primitives that comes with ratcave (although you can use any .obj file outputted by 3D modeling software), using the :py:class:`.WavefrontReader` class.
- We then retrieve a :py:class:`.Mesh` object from the file. Mesh objects contain all information about the object, including its position (inside its Local and World attributes, which are :py:class:`.Physical` objects), color (inside its Material attribute, which are of the :py:class:`.Material` class), and even the vertex data itself (inside its Data attribute, which is a :py:class:`.MeshData` object).
- We then retrieve a :py:class:`.Mesh` object from the file. Mesh objects contain all information about the object, including its position (inside its Local and World attributes, which are :py:class:`.Physical` objects), color (inside its Material attribute, which are of the :py:class:`.Material` class), and even the vertex data itself.
- We'll put the Mesh inside a :py:class:`.Scene` object, which is a container class that holds :py:class:`.Mesh` objects, a :py:class:`.Camera` object, and a :py:class:`.Light` object, along with an RGB background color. Multiple Scenes can be created, even ones that contain the same Meshes, and rendering one vs another one is as simple as calling the scene's :py:class:`Scene.draw()` method.

.. note:: Each tutorial follows from each other, assuming knowledge of the previous. To get the most out of ratcave, then, it is best to do them in order!
Expand Down
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ six
future
pytest
wavefront_reader
sphinx
sphinx
sphinx_rtd_theme

0 comments on commit 63af363

Please sign in to comment.