entrouvert
/
debian-python-pyexcel-io
17
0
Fork 0
Code Issues Pull Requests Releases Activity

update indices

This commit is contained in:
chfw 2017-06-13 08:53:57 +01:00
parent 1a519d8f93
commit b622bce483
4 changed files with 23 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.moban.d/docs/source/index.rst
View File

@ -96,6 +96,7 @@ API
.. toctree::
:maxdepth: 2
common_parameters
.. currentmodule:: pyexcel_io

4
Makefile
View File

@ -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/

7
README.rst
View File

@ -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

26
docs/source/index.rst
View File

@ -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::