Merge pull request #88 from QuantStack/docs

Improve documentation

Author: martinRenou

docs/source/api.rst

@@ -1,22 +1,41 @@
-API docs
-========
+API reference
+=============
 
-Note that ipyvolume.easy and ipyvolume.sheet are imported in the ipysheet namepsace, to you can access ipysheet.sheet instead of ipyvolume.easy.sheet.
+Note that everything is accessible from the ipysheet namespace.
+For example, you can do ``from ipysheet import sheet, from_dataframe``
 
 
 ipysheet.easy
----------------
+-------------
 
 .. automodule:: ipysheet.easy
-    :members: 
+    :members:
     :undoc-members:
     :show-inheritance:
 
+
+ipysheet.pandas_loader
+----------------------
+
+.. automodule:: ipysheet.pandas_loader
+    :members: from_dataframe, to_dataframe
+    :undoc-members:
+    :show-inheritance:
+
+
+ipysheet.numpy_loader
+---------------------
+
+.. automodule:: ipysheet.numpy_loader
+    :members: from_array, to_array
+    :undoc-members:
+    :show-inheritance:
+
+
 ipysheet.sheet
------------------
+--------------
 
 .. automodule:: ipysheet.sheet
     :members: Sheet, Cell, Range
     :undoc-members:
     :show-inheritance:
-

docs/source/conf.py

@@ -28,6 +28,8 @@
 #
 # needs_sphinx = '1.0'
 
+from ipysheet._version import __version__, __version_tuple__
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
@@ -39,7 +41,8 @@
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'nbsphinx',
-    'jupyter_sphinx.embed_widgets'
+    'jupyter_sphinx.embed_widgets',
+    'sphinx.ext.napoleon'
     ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -64,9 +67,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.1'
+version = '.'.join([str(__version_tuple__[0]), str(__version_tuple__[1])])
 # The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -103,7 +106,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

docs/source/index.ipynb

@@ -467,7 +467,7 @@
     "nbsphinx-toctree": {}
    },
    "source": [
-    "[api](api.rst)"
+    "[API Reference](api.rst)"
    ]
   }
  ],
@@ -488,7 +488,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.2"
+   "version": "3.7.1"
   },
   "widgets": {
    "application/vnd.jupyter.widget-state+json": {

ipysheet/docutils.py

@@ -0,0 +1,16 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+# This file is copied from ipywidgets
+
+
+def doc_subst(snippets):
+    """ Substitute format strings in class or function docstring """
+    def decorator(cls):
+        # Strip the snippets to avoid trailing new lines and whitespace
+        stripped_snippets = {
+            key: snippet.strip() for (key, snippet) in snippets.items()
+        }
+        cls.__doc__ = cls.__doc__.format(**stripped_snippets)
+        return cls
+    return decorator