an extension for sphinx to display excel table in sphinx documents
Project description
sphinx-excel
introduction
sphinx-excel uses openpyxl
to read an excel file and render it into sphinx document.
installation
you can install sphinx-excel by pip
.
python3 -m pip install sphinx-excel
setup
please add sphinxcontrib.excel
into your conf.py
file.
extensions = [
'sphinxcontrib.excel',
]
usage
the following code will insert the first sheet of tables.xlsx
into sphinx document.
.. excel:: ./tables.xlsx
the excel
directive will show the sheet name as the caption of table. you can use :no-caption
to remove it.
.. excel:: ./tables.xlsx
:no-caption:
if you want to specify the caption, you can use :caption:
argument.
.. excel:: ./tables.xlsx
:caption: hello world
excel
directive supports all arguments of sphinx native table
directive. for example, you can use :align:
to change table align style.
.. excel:: ./tables.xlsx
:align: center
if an excel file contains more than one sheets, you can use :sheet:
arguments to specify which sheet to be rendered.
.. excel:: ./tables.xlsx
:align: center
:sheet: stuff
the first line of table is in bold font, it means that the first line is header of table. if the table has two rows header, you can use :headers:
to tell excel
directive.
.. excel:: ./tables.xlsx
:headers: 2
one more thing
excel
directive supports to render merged cell in excel. the content of the cell can be:
- math equtions,
- code snippets, and
- other directives.
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 sphinx_excel-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e4865ec1fd54ff8ba3244e1912d2cc9868cdeb2cbe6d564297e13720fd5b931 |
|
MD5 | ed2122908111ee04a9e764e5b3b7b2d8 |
|
BLAKE2b-256 | 1ba8d2df2303bb85e819a4108f5941cc8ad5b7c631e56664d95775ea2eec340a |