Browse Source

Little tweaks to the documentation.

Mr.doob 13 years ago
parent
commit
a31d23e723
5 changed files with 44 additions and 40 deletions
  1. 4 3
      docs/api/cameras/index.rst
  2. 23 22
      docs/api/core/index.rst
  3. 5 5
      docs/api/lights/index.rst
  4. 2 2
      docs/conf.py
  5. 10 8
      docs/index.rst

+ 4 - 3
docs/api/cameras/index.rst

@@ -2,6 +2,7 @@ Cameras
 =======
 
 .. toctree::
-    Camera
-    OrthographicCamera
-    PerspectiveCamera
+
+   Camera
+   OrthographicCamera
+   PerspectiveCamera

+ 23 - 22
docs/api/core/index.rst

@@ -1,24 +1,25 @@
-Core Classes
-============
+Core
+====
 
 .. toctree::
-    Clock
-    Color
-    Edge
-    Face3
-    Face4
-    Geometry
-    Math
-    Matrix3
-    Matrix4
-    Object3D
-    Projector
-    Quaternion
-    Ray
-    Rectangle
-    Spline
-    UV
-    Vector2
-    Vector3
-    Vector4
-    Vertex
+
+   Clock
+   Color
+   Edge
+   Face3
+   Face4
+   Geometry
+   Math
+   Matrix3
+   Matrix4
+   Object3D
+   Projector
+   Quaternion
+   Ray
+   Rectangle
+   Spline
+   UV
+   Vector2
+   Vector3
+   Vector4
+   Vertex

+ 5 - 5
docs/api/lights/index.rst

@@ -2,9 +2,9 @@ Lights
 ======
 
 .. toctree::
-    Light
 
-    AmbientLight
-    DirectionalLight
-    PointLight
-    SpotLight
+   Light
+   AmbientLight
+   DirectionalLight
+   PointLight
+   SpotLight

+ 2 - 2
docs/conf.py

@@ -48,9 +48,9 @@ copyright = u'2010-2012, three.js Authors'
 # built documents.
 #
 # The short X.Y version.
-version = 'r48dev'
+version = '48dev'
 # The full version, including alpha/beta/rc tags.
-release = 'r48dev'
+release = '48dev'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

+ 10 - 8
docs/index.rst

@@ -1,9 +1,9 @@
-three.js - Javascript 3D Engine
+three.js - JavaScript 3D library
 ===============================
 
-The aim of the project is to create a lightweight 3D engine with a very low
-level of complexity — in other words, for dummies. The engine can render using
-<canvas>, <svg> and WebGL.
+The aim of the project is to create a lightweight 3D library with a very low
+level of complexity — in other words, for dummies. The library provides
+<canvas>, <svg> and WebGL renderers.
 
 * `Clone on GitGub <https://github.com/mrdoob/three.js>`_
 * `Report an Issue <https://github.com/mrdoob/three.js/issues>`_
@@ -13,17 +13,19 @@ Contents
 --------
 
 .. toctree::
-    :maxdepth: 1
+   :maxdepth: 1
 
-    changelog.rst
-    tutorials/index.rst
+   changelog.rst
+   tutorials/index.rst
 
 API
 ---
 
 .. toctree::
 
-    api/THREE.rst
+   api/cameras/index.rst
+   api/core/index.rst
+   api/lights/index.rst
 
 Indices and tables
 ==================