A sphinx extension for making table from Excel file
Project description
A sphinx extension for making table from Excel file.
Depends on OpenPyXL
Supports xlsx file
Supports merged cell
Supports Japanese
This extension generates a grid table string internally from Excel file.
Install and Set up
Install from PyPI.
$ pip install sphinxcontrib-xlsxtable
Configure conf.py
# conf.py
extensions = [
'sphinxcontrib.xlsxtable',
]
Usage
reStructuredText directive:
.. xlsx-table:: Table Caption
:file: path/to/xlsx/file.xlsx
:header-rows: 1
Excel file:
Rendered HTML:
Options
:file: (required)
Specifies path to Excel file. You can use relative path.
.. xlsx-table::
:file: path/to/xlsx/file.xlsx
:header-rows: (optional)
Specified the number of lines are used as header.
.. xlsx-table::
:file: path/to/xlsx/file.xlsx
:header-rows: 1
:sheet: (optional)
Generates a table from a sheet with the specified sheet name.
If this option is not specified, current active sheet is used.
.. xlsx-table::
:file: path/to/xlsx/file.xlsx
:sheet: Sheet1
:start-row: (optional)
Specifies start row number.
.. xlsx-table::
:file: path/to/xlsx/file.xlsx
:start-row: 2
:start-column: (optional)
Specifies start column number.
.. xlsx-table::
:file: path/to/xlsx/file.xlsx
:start-column: 2
:include-rows: / :exclude-rows: (optional)
Specifies include or exclude rows. Exclude setting has priority.
.. xlsx-table::
:file: path/to/xlsx/file.xlsx
:include-rows: 1-2 4 8
:exclude-rows: 3 5-7
:include-columns: / :exclude-columns: (optional)
Specifies include or exclude columns. Exclude setting has priority.
.. xlsx-table::
:file: path/to/xlsx/file.xlsx
:include-columns: A-B 4
:exclude-columns: C 5-6
CLI
You can use from CLI.
$ python -m sphinxcontrib.xlsxtable --sheet=Sheet1 --header-rows=1 test/_res/sample.xlsx
+----+-------+-------+--------+
| A1 | B1 | C1 | D1 |
+====+=======+=======+========+
| A2 | B2:B3 | C2 | D2 |
+----+ +-------+--------+
| A3 | | C3:D3 |
+----+-------+-------+--------+
| A4 | B4 | C4 | - D4-1 |
| | | | - D4-2 |
+----+-------+-------+--------+
LICENSE
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxcontrib-xlsxtable-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd1028fe261180ccd16aac91b8842edf45002a5e41700cc06f7cbb8d85f80c82 |
|
MD5 | 61df316fa919407a3907a7726bbb4b90 |
|
BLAKE2b-256 | 6373d0c4cae0f3a703ac738cabbb9c8c2d9f015923c06dab227bc9e930bad9e8 |
Hashes for sphinxcontrib_xlsxtable-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ce256ed730c8b816ac5a8ea1ad6db13e1ed01ce14e8eeff8d21ab6dc26bae50 |
|
MD5 | 3a17ab547bf397ac2d1e6d3802edf4c5 |
|
BLAKE2b-256 | edf86e1c32830c532c2404580ae37ac530c68be38bbe6c9436e40a60d97994a9 |