Add installation guide section and reorganize docs

addresses #17
r9y9 · Sep 7, 2015 · d1a952a · d1a952a
1 parent 500af28
commit d1a952a
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 12 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -1,11 +1,9 @@
-SPTK API
-========
+API
+===
 
-All functionality in ``pysptk.sptk`` is directly accesible from the top-level ``pysptk.*`` namespace.
+.. toctree::
+    :maxdepth: 2
 
-.. note:: Almost all of pysptk functions assume that the input array is **C-contiguous** and has ``float64`` element type.
-
-.. automodule:: pysptk.sptk
-
-
-.. automodule:: pysptk.conversion
+    sptk
+    synthesis
+    util
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,16 +8,22 @@ pysptk
 
 .. automodule:: pysptk
 
+Installation guide
+------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    introduction
+
+
 API documentation
 -----------------
 
 .. toctree::
     :maxdepth: 2
 
     api
-    synthesis
-    util
-
 
 
 Indices and tables

diff --git a/docs/introduction.rst b/docs/introduction.rst
@@ -0,0 +1,31 @@
+Installation guide
+==================
+
+The latest release is availabe on pypi. You can install it by:
+
+.. code::
+
+    pip install pysptk
+
+Note that you have to install ``numpy`` to build C-extensions.
+
+If yout want the latest development version, run:
+
+.. code::
+
+   pip install git+https://github.com/r9y9/pysptk
+
+or:
+
+.. code::
+
+   git clone https://github.com/r9y9/pysptk
+   cd pysptk
+   python setup.py develop # or install
+
+This should resolve the package dependencies and install ``pysptk`` property.
+
+
+.. note::
+
+   If you use the development version, you need ``cython`` installed to compile cython module(s).
diff --git a/docs/sptk.rst b/docs/sptk.rst
@@ -0,0 +1,10 @@
+Core SPTK API
+=============
+
+All functionality in ``pysptk.sptk`` is directly accesible from the top-level ``pysptk.*`` namespace.
+
+.. note:: Almost all of pysptk functions assume that the input array is **C-contiguous** and has ``float64`` element type.
+
+.. automodule:: pysptk.sptk
+
+.. automodule:: pysptk.conversion