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 images
Supports Japanese
This extension generates a grid table string internally from Excel file.
Install and Set up
Install from PyPI.
$ pip install sphinxcontrib-xlsxtableConfigure conf.py
# conf.py
extensions = [
'sphinxcontrib.xlsxtable',
]Usage
reStructuredText directive:
.. xlsx-table:: Table Caption
:file: path/to/xlsx/file.xlsx
:header-rows: 1Excel file:
Rendered HTML:
Options
Caption (optional)
Specifies table caption string.
.. xlsx-table:: Table Caption
:file: path/to/xlsx/file.xlsx: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-6CLI
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 |
+----+-------+-------+--------+Links
LICENSE
MIT
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.1.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 316f3021c40b4088e295722808ae7e6f4c0edb2fa3d515f85b01d31e6bcf7f90 |
|
| MD5 | 9d6198c661466534272346b38cf242ec |
|
| BLAKE2b-256 | 6c4f481916f5becab113a37d7b3dfb1ee07a6c9c6d448621e467d8fde1c592c7 |
Hashes for sphinxcontrib_xlsxtable-1.1.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 83f36b1305f6a302efce5b70f6fb9460856b07b30ca5a5cb62557be51eb45519 |
|
| MD5 | 0da4489415ebfe3d3226a4e65b4fe125 |
|
| BLAKE2b-256 | 350550a86ea2017a69b10c31c3a7e8fcf8ed36df0a4d147bbbc26a658d56e539 |
