More docs

Author: vidartf

docs/source/api/traits.rst

@@ -0,0 +1,11 @@
+
+
+======
+traits
+======
+
+.. py:currentmodule:: pythreejs
+
+.. automodule:: pythreejs.traits
+    :members:
+    :undoc-members:

docs/source/conf.py

@@ -187,3 +187,8 @@
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # otherwise, readthedocs.org uses their theme by default, so no need to specify it
+
+
+# Ignore anchored API links (javascript uses the anchors, otherwise invalid)
+linkcheck_ignore = [r'https://threejs.org/docs/#(api|manual)']
+# linkcheck_anchors_ignore = ['^!', '^api', '^manual']

docs/sphinxext/autodoc_traits.py

@@ -2,7 +2,7 @@
 
 from collections import OrderedDict
 
-from traitlets import TraitType, Undefined, Container, Dict, Any
+from traitlets import TraitType, Undefined, Container, Dict, Any, HasTraits
 from sphinx.ext.autodoc import ClassDocumenter, AttributeDocumenter
 
 
@@ -38,6 +38,10 @@ class HasTraitsDocumenter(ClassDocumenter):
     objtype = 'hastraits'
     directivetype = 'class'
 
+    @classmethod
+    def can_document_member(cls, member, membername, isattr, parent):
+        return isinstance(member, HasTraits)
+
     def get_object_members(self, want_all):
         """Add traits to members list"""
         check, members = super().get_object_members(want_all)

js/scripts/templates/autodoc_index.mustache

@@ -5,6 +5,17 @@
 API Reference
 =============
 
+The pythreejs API attempts to mimic `the three.js API`_ as closely as possible.
+This API reference therefore does not attempt to explain the purpose of any
+forwarded objects or attributes, but can  still be useful for:
+
+- The trait signatures of various properties.
+- Classes, properties and methods custom to pythreejs.
+- Variations from the three.js API, e.g. for :py:class:`~pythreejs.BufferAttribute`.
+
+.. _`the three.js API`: https://threejs.org/docs/
+
+
 .. automodule:: pythreejs
     :members:
     :undoc-members:

setup.py

@@ -72,6 +72,9 @@
             'matplotlib',
             'scikit-image'
         ],
+        'docs': [
+            'sphinx>=1.5',
+        ]
     },
     'packages': [name],  # Manually specify here, update after autogen
     'zip_safe': False,