demo_docs tests

demo_docs/source/conf.py

@@ -13,6 +13,9 @@
 
 import sys, os
 
+sys.path.append(os.path.abspath('.'))
+sys.path.append(os.path.abspath('./test_py_module'))
+
 # 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
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -25,7 +28,7 @@ import sys, os
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
+extensions = ['sphinx.ext.autodoc',]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

demo_docs/source/index.rst

@@ -13,6 +13,55 @@ Contents:
 
 test
 
+API Test
+========
+
+.. automodule:: test_py_module.test
+    :members:
+    :private-members:
+    :special-members:
+
+Code test
+=========
+
+.. code-block:: json
+
+    {
+    "windows": [
+        {
+        "panes": [
+            {
+            "shell_command": [
+                "echo 'did you know'", 
+                "echo 'you can inline'"
+            ]
+            }, 
+            {
+            "shell_command": "echo 'single commands'"
+            }, 
+            "echo 'for panes'"
+        ], 
+        "window_name": "long form"
+        }
+    ], 
+    "session_name": "shorthands"
+    }
+
+Sidebar
+=======
+
+.. sidebar:: Ch'ien / The Creative
+
+    .. image:: static/yi_jing_01_chien.jpg
+
+    *Above* CH'IEN THE CREATIVE, HEAVEN
+
+    *Below* CH'IEN THE CREATIVE, HEAVEN
+
+The first hexagram is made up of six unbroken lines. These unbroken lines stand for the primal power, which is light-giving, active, strong, and of the spirit. The hexagram is consistently strong in character, and since it is without weakness, its essence is power or energy. Its image is heaven. Its energy is represented as unrestricted by any fixed conditions in space and is therefore conceived of as motion. Time is regarded as the basis of this motion. Thus the hexagram includes also the power of time and the power of persisting in time, that is, duration.
+
+The power represented by the hexagram is to be interpreted in a dual sense in terms of its action on the universe and of its action on the world of men. In relation to the universe, the hexagram expresses the strong, creative action of the Deity. In relation to the human world, it denotes the creative action of the holy man or sage, of the ruler or leader of men, who through his power awakens and develops their higher nature.
+
 Indices and tables
 ==================
 

demo_docs/source/test_py_module/test.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+
+class Foo:
+    """Docstring for class Foo."""
+
+    #: Doc comment for class attribute Foo.bar.
+    #: It can have multiple lines.
+    bar = 1
+
+    flox = 1.5   #: Doc comment for Foo.flox. One line only.
+
+    baz = 2
+    """Docstring for class attribute Foo.baz."""
+
+    def __init__(self):
+        #: Doc comment for instance attribute qux.
+        self.qux = 3
+
+        self.spam = 4
+        """Docstring for instance attribute spam."""