From b622bce4832d2d8946a3b16651a4ec7034ca8f54 Mon Sep 17 00:00:00 2001 From: chfw Date: Tue, 13 Jun 2017 08:53:57 +0100 Subject: [PATCH] update indices --- .moban.d/docs/source/index.rst | 1 + Makefile | 4 ++-- README.rst | 7 +++++++ docs/source/index.rst | 26 +++++++++++++------------- 4 files changed, 23 insertions(+), 15 deletions(-) diff --git a/.moban.d/docs/source/index.rst b/.moban.d/docs/source/index.rst index bcbd26b..d9b3c8f 100644 --- a/.moban.d/docs/source/index.rst +++ b/.moban.d/docs/source/index.rst @@ -96,6 +96,7 @@ API .. toctree:: :maxdepth: 2 + common_parameters .. currentmodule:: pyexcel_io diff --git a/Makefile b/Makefile index 7758e41..7f442b5 100644 --- a/Makefile +++ b/Makefile @@ -4,5 +4,5 @@ test: bash test.sh document: - sphinx-autogen -o doc/source/generated/ doc/source/*.rst - sphinx-build -b html doc/source/ doc/build/ + sphinx-autogen -o docs/source/generated/ docs/source/*.rst + sphinx-build -b html docs/source/ docs/build/ diff --git a/README.rst b/README.rst index 00942b0..cc0db5f 100644 --- a/README.rst +++ b/README.rst @@ -63,6 +63,13 @@ sqlalchemy supported databases. Its supported file formats are extended to cover .. _odfpy: https://github.com/eea/odfpy +In order to manage the list of plugins installed, you need to use pip to add or remove +a plugin. When you use virtualenv, you can have different plugins per virtual +environment. In the situation where you have multiple plugins that does the same thing +in your environment, you need to tell pyexcel which plugin to use per function call. +For example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr. +You need to append get_array(..., library='pyexcel-odsr'). + .. rubric:: Footnotes .. [#f1] zipped csv file diff --git a/docs/source/index.rst b/docs/source/index.rst index 952f057..1dd2c72 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -96,6 +96,13 @@ For individual excel file formats, please install them as you wish: .. _odfpy: https://github.com/eea/odfpy +In order to manage the list of plugins installed, you need to use pip to add or remove +a plugin. When you use virtualenv, you can have different plugins per virtual +environment. In the situation where you have multiple plugins that does the same thing +in your environment, you need to tell pyexcel which plugin to use per function call. +For example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr. +You need to append get_array(..., library='pyexcel-odsr'). + .. rubric:: Footnotes .. [#f1] zipped csv file @@ -132,24 +139,12 @@ get_data(.., library='pyexcel-ods') .. _ods: https://github.com/pyexcel/pyexcel-ods .. _ods3: https://github.com/pyexcel/pyexcel-ods3 -Special Note on PyInstaller -******************************************************************************** - -When you packaging pyexcel-io with its plugins, please specify the plugins in -its hidden import options:: - - --hidden-import pyexcel_[nick_name] --hidden-import pyexcel_[nick_name].[nick_name] - -Nick name here refers to the second part of the package name. Suppose you -wanted to package pyexcel-xls with pyexcel-io, the options to pyinstaller are:: - - --hidden-import pyexcel_xls --hidden-import pyexcel_xls.xls .. toctree:: :caption: Migration Note :maxdepth: 2 - migration_from_dot_1_to_dot_2 + pyinstaller .. toctree:: :caption: Tutorial @@ -168,6 +163,11 @@ wanted to package pyexcel-xls with pyexcel-io, the options to pyinstaller are:: API -------------------------------------------------- +.. toctree:: + :maxdepth: 2 + + common_parameters + .. currentmodule:: pyexcel_io .. autosummary::