Skip to main content

an extension for sphinx to display excel table in sphinx documents

Project description

sphinx-excel

sphinx-excel Documentation Status pytest mypy flake8 pytest

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-excel-1.0.1.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

sphinx_excel-1.0.1-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-excel-1.0.1.tar.gz.

File metadata

  • Download URL: sphinx-excel-1.0.1.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.12 tqdm/4.64.0 importlib-metadata/5.0.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.6

File hashes

Hashes for sphinx-excel-1.0.1.tar.gz
Algorithm Hash digest
SHA256 ef0bdb324399f17c0cf55704621ff7f7b976c1bac648d9820de9a28b605d5e59
MD5 4e732052f7bec4740a39b02674b6f3c5
BLAKE2b-256 1c8b0a560a3d023081e9dff76ea25edd4ec170fd5b366d22641523a378a565d8

See more details on using hashes here.

File details

Details for the file sphinx_excel-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: sphinx_excel-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.12 tqdm/4.64.0 importlib-metadata/5.0.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.6

File hashes

Hashes for sphinx_excel-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5e4865ec1fd54ff8ba3244e1912d2cc9868cdeb2cbe6d564297e13720fd5b931
MD5 ed2122908111ee04a9e764e5b3b7b2d8
BLAKE2b-256 1ba8d2df2303bb85e819a4108f5941cc8ad5b7c631e56664d95775ea2eec340a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page