Skip to content

Commit bc8d573

Browse files
committed
update documentation
1 parent dab0e0e commit bc8d573

File tree

3 files changed

+30
-6
lines changed

3 files changed

+30
-6
lines changed

README.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ The highlighted features are:
7979
mediawiki, html, 3.5, pypy, pypy3
8080
latex, grid, pipe,
8181
orgtbl, plain simple
82-
`pyexcel-handsontable`_ handsontable in html `handsontable`_ same as above
83-
`pyexcel-chart`_ svg chart `pygal`_ same as above
82+
`pyexcel-handsontable`_ handsontable in html `handsontable`_ same as above [#f3]_
83+
`pyexcel-pygal`_ svg chart `pygal`_ same as above [#f3]_
8484
======================== ======================= =============== ==================
8585

8686
.. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
@@ -102,8 +102,19 @@ The highlighted features are:
102102
.. _tabulate: https://bitbucket.org/astanin/python-tabulate
103103
.. _pyexcel-handsontable: https://github.com/pyexcel/pyexcel-handsontable
104104
.. _handsontable: https://cdnjs.com/libraries/handsontable
105-
.. _pyexcel-chart: https://github.com/pyexcel/pyexcel-chart
105+
.. _pyexcel-pygal: https://github.com/pyexcel/pyexcel-chart
106106
.. _pygal: https://github.com/Kozea/pygal
107+
.. _pyexcel-matplotlib: https://github.com/pyexcel/pyexcel-matplotlib
108+
.. _matplotlib: https://matplotlib.org
109+
110+
.. [#f3] coming soon
111+
112+
In order to manage the list of plugins installed, you need to use pip to add or remove
113+
a plugin. When you use virtualenv, you can have different plugins per virtual
114+
environment. In the situation where you have multiple plugins that does the same thing
115+
in your environment, you need to tell pyexcel which plugin to use per function call.
116+
For example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr.
117+
You need to append get_array(..., library='pyexcel-odsr').
107118

108119
.. rubric:: Footnotes
109120

doc/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
sphinxcontrib-spelling
2+

doc/source/index.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ The highlighted features are:
7474
mediawiki, html, 3.5, pypy, pypy3
7575
latex, grid, pipe,
7676
orgtbl, plain simple
77-
`pyexcel-handsontable`_ handsontable in html `handsontable`_ same as above
78-
`pyexcel-chart`_ svg chart `pygal`_ same as above
77+
`pyexcel-handsontable`_ handsontable in html `handsontable`_ same as above [#f3]_
78+
`pyexcel-pygal`_ svg chart `pygal`_ same as above [#f3]_
7979
======================== ======================= =============== ==================
8080

8181
.. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
@@ -97,8 +97,19 @@ The highlighted features are:
9797
.. _tabulate: https://bitbucket.org/astanin/python-tabulate
9898
.. _pyexcel-handsontable: https://github.com/pyexcel/pyexcel-handsontable
9999
.. _handsontable: https://cdnjs.com/libraries/handsontable
100-
.. _pyexcel-chart: https://github.com/pyexcel/pyexcel-chart
100+
.. _pyexcel-pygal: https://github.com/pyexcel/pyexcel-chart
101101
.. _pygal: https://github.com/Kozea/pygal
102+
.. _pyexcel-matplotlib: https://github.com/pyexcel/pyexcel-matplotlib
103+
.. _matplotlib: https://matplotlib.org
104+
105+
.. [#f3] coming soon
106+
107+
In order to manage the list of plugins installed, you need to use pip to add or remove
108+
a plugin. When you use virtualenv, you can have different plugins per virtual
109+
environment. In the situation where you have multiple plugins that does the same thing
110+
in your environment, you need to tell pyexcel which plugin to use per function call.
111+
For example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr.
112+
You need to append get_array(..., library='pyexcel-odsr').
102113

103114
.. rubric:: Footnotes
104115

0 commit comments

Comments
 (0)