Skip to content

Commit 60f4de3

Browse files
chfwchfw
committed
📚 update documentations
1 parent a3770e9 commit 60f4de3

File tree

5 files changed

+46
-44
lines changed

5 files changed

+46
-44
lines changed

‎.moban.d/setup.py‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
1-
{% extends 'setup.py.jj2' %}
1+
{% extends 'pyexcel-setup.py.jj2' %}
22

33
{%block platform_block%}
44
{%endblock%}
55

66
{%block extras %}
77
{%endblock %}
88

9-
{%block additional_keywords%}
10-
'API',
11-
'Django'
12-
{%endblock%}
13-
14-
{%block additional_classifiers%}
9+
{%block pyexcel_extra_classifiers%}
1510
'Development Status :: 3 - Alpha',
1611
'Environment :: Web Environment',
1712
'Topic :: Internet :: WWW/HTTP',

‎README.rst‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -81,32 +81,34 @@ The highlighted features are:
8181

8282
.. table:: A list of file formats supported by external plugins
8383

84-
======================== ======================= =============== ==================
85-
Package name Supported file formats Dependencies Python versions
86-
======================== ======================= =============== ==================
87-
`pyexcel-io`_ csv, csvz [#f1]_, tsv, 2.6, 2.7, 3.3,
88-
tsvz [#f2]_ 3.4, 3.5, 3.6
89-
pypy
90-
`pyexcel-xls`_ xls, xlsx(read only), `xlrd`_, same as above
84+
======================== ======================= ================= ==================
85+
Package name Supported file formats Dependencies Python versions
86+
======================== ======================= ================= ==================
87+
`pyexcel-io`_ csv, csvz [#f1]_, tsv, 2.6, 2.7, 3.3,
88+
tsvz [#f2]_ 3.4, 3.5, 3.6
89+
pypy
90+
`pyexcel-xls`_ xls, xlsx(read only), `xlrd`_, same as above
9191
xlsm(read only) `xlwt`_
92-
`pyexcel-xlsx`_ xlsx `openpyxl`_ same as above
93-
`pyexcel-xlsxw`_ xlsx(write only) `XlsxWriter`_ same as above
94-
`pyexcel-ods3`_ ods `ezodf`_, 2.6, 2.7, 3.3, 3.4
95-
lxml 3.5, 3.6
96-
`pyexcel-ods`_ ods `odfpy`_ same as above
97-
`pyexcel-odsr`_ read only for ods, fods lxml same as above
98-
`pyexcel-htmlr`_ html(read only) lxml,html5lib same as above
99-
`pyexcel-text`_ (write only)json, rst, `tabulate`_ 2.6, 2.7, 3.3, 3.4
92+
`pyexcel-xlsx`_ xlsx `openpyxl`_ same as above
93+
`pyexcel-xlsxw`_ xlsx(write only) `XlsxWriter`_ same as above
94+
`pyexcel-ods3`_ ods `pyexcel-ezodf`_, 2.6, 2.7, 3.3, 3.4
95+
lxml 3.5, 3.6
96+
`pyexcel-ods`_ ods `odfpy`_ same as above
97+
`pyexcel-odsr`_ read only for ods, fods lxml same as above
98+
`pyexcel-htmlr`_ html(read only) lxml,html5lib same as above
99+
`pyexcel-text`_ write only:rst, `tabulate`_ 2.6, 2.7, 3.3, 3.4
100100
mediawiki, html, 3.5, 3.6, pypy
101101
latex, grid, pipe,
102102
orgtbl, plain simple
103+
read only: ndjson
104+
r/w: json
103105
`pyexcel-handsontable`_ handsontable in html `handsontable`_ same as above
104106
`pyexcel-pygal`_ svg chart `pygal`_ 2.7, 3.3, 3.4, 3.5
105107
3.6, pypy
106108
`pyexcel-sortable`_ sortable table in html `csvtotable`_ same as above
107109
`pyexcel-gantt`_ gantt chart in html `frappe-gantt`_ except pypy, same
108110
as above
109-
======================== ======================= =============== ==================
111+
======================== ======================= ================= ==================
110112

111113
.. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
112114
.. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls
@@ -121,7 +123,7 @@ The highlighted features are:
121123
.. _xlwt: https://github.com/python-excel/xlwt
122124
.. _openpyxl: https://bitbucket.org/openpyxl/openpyxl
123125
.. _XlsxWriter: https://github.com/jmcnamara/XlsxWriter
124-
.. _ezodf: https://github.com/T0ha/ezodf
126+
.. _pyexcel-ezodf: https://github.com/pyexcel/pyexcel-ezodf
125127
.. _odfpy: https://github.com/eea/odfpy
126128

127129
.. _pyexcel-text: https://github.com/pyexcel/pyexcel-text
@@ -292,7 +294,7 @@ How to update test environment and update documentation
292294
Additional steps are required:
293295

294296
#. pip install moban
295-
#. git clone https://github.com/pyexcel/setupmobans.git # generic setup
297+
#. git clone https://github.com/moremoban/setupmobans.git # generic setup
296298
#. git clone https://github.com/pyexcel/pyexcel-commons.git commons
297299
#. make your changes in `.moban.d` directory, then issue command `moban`
298300

‎django_excel.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,8 @@ extra_dependencies:
1414
- pyexcel-xlsx>=0.4.0
1515
- ods:
1616
- pyexcel-ods3>=0.4.0
17+
keywords:
18+
- API
19+
- Django
1720
description:
1821
A django middleware that provides one application programming interface to read and write data in different excel file formats

‎docs/source/index.rst‎

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -55,32 +55,34 @@ The highlighted features are:
5555

5656
.. table:: A list of file formats supported by external plugins
5757

58-
======================== ======================= =============== ==================
59-
Package name Supported file formats Dependencies Python versions
60-
======================== ======================= =============== ==================
61-
`pyexcel-io`_ csv, csvz [#f1]_, tsv, 2.6, 2.7, 3.3,
62-
tsvz [#f2]_ 3.4, 3.5, 3.6
63-
pypy
64-
`pyexcel-xls`_ xls, xlsx(read only), `xlrd`_, same as above
58+
======================== ======================= ================= ==================
59+
Package name Supported file formats Dependencies Python versions
60+
======================== ======================= ================= ==================
61+
`pyexcel-io`_ csv, csvz [#f1]_, tsv, 2.6, 2.7, 3.3,
62+
tsvz [#f2]_ 3.4, 3.5, 3.6
63+
pypy
64+
`pyexcel-xls`_ xls, xlsx(read only), `xlrd`_, same as above
6565
xlsm(read only) `xlwt`_
66-
`pyexcel-xlsx`_ xlsx `openpyxl`_ same as above
67-
`pyexcel-xlsxw`_ xlsx(write only) `XlsxWriter`_ same as above
68-
`pyexcel-ods3`_ ods `ezodf`_, 2.6, 2.7, 3.3, 3.4
69-
lxml 3.5, 3.6
70-
`pyexcel-ods`_ ods `odfpy`_ same as above
71-
`pyexcel-odsr`_ read only for ods, fods lxml same as above
72-
`pyexcel-htmlr`_ html(read only) lxml,html5lib same as above
73-
`pyexcel-text`_ (write only)json, rst, `tabulate`_ 2.6, 2.7, 3.3, 3.4
66+
`pyexcel-xlsx`_ xlsx `openpyxl`_ same as above
67+
`pyexcel-xlsxw`_ xlsx(write only) `XlsxWriter`_ same as above
68+
`pyexcel-ods3`_ ods `pyexcel-ezodf`_, 2.6, 2.7, 3.3, 3.4
69+
lxml 3.5, 3.6
70+
`pyexcel-ods`_ ods `odfpy`_ same as above
71+
`pyexcel-odsr`_ read only for ods, fods lxml same as above
72+
`pyexcel-htmlr`_ html(read only) lxml,html5lib same as above
73+
`pyexcel-text`_ write only:rst, `tabulate`_ 2.6, 2.7, 3.3, 3.4
7474
mediawiki, html, 3.5, 3.6, pypy
7575
latex, grid, pipe,
7676
orgtbl, plain simple
77+
read only: ndjson
78+
r/w: json
7779
`pyexcel-handsontable`_ handsontable in html `handsontable`_ same as above
7880
`pyexcel-pygal`_ svg chart `pygal`_ 2.7, 3.3, 3.4, 3.5
7981
3.6, pypy
8082
`pyexcel-sortable`_ sortable table in html `csvtotable`_ same as above
8183
`pyexcel-gantt`_ gantt chart in html `frappe-gantt`_ except pypy, same
8284
as above
83-
======================== ======================= =============== ==================
85+
======================== ======================= ================= ==================
8486

8587
.. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
8688
.. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls
@@ -95,7 +97,7 @@ The highlighted features are:
9597
.. _xlwt: https://github.com/python-excel/xlwt
9698
.. _openpyxl: https://bitbucket.org/openpyxl/openpyxl
9799
.. _XlsxWriter: https://github.com/jmcnamara/XlsxWriter
98-
.. _ezodf: https://github.com/T0ha/ezodf
100+
.. _pyexcel-ezodf: https://github.com/pyexcel/pyexcel-ezodf
99101
.. _odfpy: https://github.com/eea/odfpy
100102

101103
.. _pyexcel-text: https://github.com/pyexcel/pyexcel-text

‎setup.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
FILES = ['README.rst', 'CHANGELOG.rst']
2424
KEYWORDS = [
2525
'API',
26-
'Django'
26+
'Django',
2727
'python'
2828
]
2929

@@ -32,14 +32,14 @@
3232
'Topic :: Utilities',
3333
'Topic :: Software Development :: Libraries',
3434
'Programming Language :: Python',
35-
'License :: OSI Approved :: BSD License',
3635
'Intended Audience :: Developers',
3736
'Programming Language :: Python :: 2.6',
3837
'Programming Language :: Python :: 2.7',
3938
'Programming Language :: Python :: 3.3',
4039
'Programming Language :: Python :: 3.4',
4140
'Programming Language :: Python :: 3.5',
4241
'Programming Language :: Python :: 3.6',
42+
'License :: OSI Approved :: BSD License',
4343
'Development Status :: 3 - Alpha',
4444
'Environment :: Web Environment',
4545
'Topic :: Internet :: WWW/HTTP',

0 commit comments

Comments
 (0)