documentation update

pyexcel · May 20, 2015 · afdbd5b · afdbd5b
1 parent 136a3fe
commit afdbd5b
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 11 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -136,6 +136,8 @@
 # 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']
+def setup(app):
+    app.add_stylesheet('theme_overrides.css')
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

diff --git a/doc/source/django.rst b/doc/source/django.rst
@@ -47,6 +47,11 @@ used here to demonstate it::
     ...     def __call__(self, **keywords):
     ...         return keywords
 
+.. note::
+   You can visit
+   `django-excel documentation <http://django-excel.readthedocs.org/en/latest/>`_
+   if you would prefer a real django model to be used in tutorial.
+
 Write data to a django model
 --------------------------------------------------------------------------------
 

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -57,15 +57,15 @@ For individual excel file formats, please install them as you wish:
 .. _a-map-of-plugins-and-file-formats:
 .. table:: a map of plugins and supported excel file formats
 
-   ============== ======================================= ============= ======================== =============================   
-   Package name   Supported file formats                  Dependencies  Python versions          Comments                       
-   ============== ======================================= ============= ======================== =============================   
-   `pyexcel-io`_  csv, csvz [#f1]_, tsv, tsvz [#f2]_                    2.6, 2.7, 3.3, 3.4, pypy                                
-   `xls`_         xls, xlsx(read only), xlsm(read only)   xlrd, xlwt    2.6, 2.7, 3.3, 3.4, pypy supports reading xlsx as well
-   `xlsx`_        xlsx                                    openpyxl      2.6, 2.7, 3.3, 3.4, pypy                                 
-   `ods3`_        ods                                     ezodf, lxml   2.6, 2.7, 3.3, 3.4                                               
-   `ods`_         ods (python 2.6, 2.7)                   odfpy         2.6, 2.7                                             
-   ============== ======================================= ============= ======================== =============================
+   ============== ======================================= ============= ========================   
+   Package name   Supported file formats                  Dependencies  Python versions           
+   ============== ======================================= ============= ========================   
+   `pyexcel-io`_  csv, csvz [#f1]_, tsv, tsvz [#f2]_                    2.6, 2.7, 3.3, 3.4, pypy  
+   `xls`_         xls, xlsx(read only), xlsm(read only)   xlrd, xlwt    2.6, 2.7, 3.3, 3.4, pypy
+   `xlsx`_        xlsx                                    openpyxl      2.6, 2.7, 3.3, 3.4, pypy   
+   `ods3`_        ods                                     ezodf, lxml   2.6, 2.7, 3.3, 3.4                 
+   `ods`_         ods (python 2.6, 2.7)                   odfpy         2.6, 2.7                
+   ============== ======================================= ============= ========================
 
 Please import them before you start to access the desired file formats::
 
@@ -90,7 +90,7 @@ After that, you can start get and save data in the loaded format.
 .. _ods: https://github.com/chfw/pyexcel-ods
 .. _ods3: https://github.com/chfw/pyexcel-ods3
 
-Contents:
+Tutorial
 -------------------------------------------------
 .. toctree::
    :maxdepth: 2
@@ -102,6 +102,7 @@ Contents:
    django
    extensions
 
+
 API
 --------------------------------------------------
 
@@ -112,6 +113,12 @@ API
 
    get_data
    save_data
+
+Utility functions
+
+.. autosummary::
+   :toctree: api/
+
    get_io
 
 

diff --git a/pyexcel_io/__init__.py b/pyexcel_io/__init__.py
@@ -53,7 +53,7 @@
                        FILE_FORMAT_ODS, FILE_FORMAT_XLS,
                        FILE_FORMAT_XLSX, FILE_FORMAT_XLSM]
 
-# A list of registered readers
+#A list of registered readers
 READERS = {
     FILE_FORMAT_CSV: CSVBook,
     FILE_FORMAT_TSV: partial(CSVBook, dialect="excel-tab"),