docs: some fixes to Glfw integration documentation

pyimgui · Nov 17, 2016 · 1b9c85b · 1b9c85b
1 parent 31e59e6
commit 1b9c85b
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 3 deletions.
diff --git a/doc/requirements-docs.txt b/doc/requirements-docs.txt
@@ -2,5 +2,6 @@ Cython
 Sphinx==1.4.8
 sphinxcontrib-napoleon
 PyOpenGL
+glfw
 pypandoc
 git-lfs
diff --git a/doc/source/reference/imgui.impl.rst b/doc/source/reference/imgui.impl.rst
@@ -2,5 +2,7 @@ imgui.impl subpackage
 =====================
 
 
-.. automodule:: imgui.impl
+.. autoclass:: imgui.impl.GlfwImpl
+    :undoc-members:
     :members:
+
diff --git a/imgui/impl/__init__.py b/imgui/impl/__init__.py
@@ -1,2 +1,7 @@
 # -*- coding: utf-8 -*-
-from imgui.impl._glfw import Impl as GlfwImpl
+from imgui.impl._glfw import GlfwImpl
+
+
+__all__ = [
+    'GlfwImpl'
+]
diff --git a/imgui/impl/_glfw.py b/imgui/impl/_glfw.py
@@ -6,7 +6,9 @@
 import ctypes
 
 
-class Impl(object):
+class GlfwImpl(object):
+    """Basic GLFW3 integration implementation."""
+
     VERTEX_SHADER_SRC = """
     #version 330