Skip to main content

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:

https://raw.githubusercontent.com/kkAyataka/sphinxcontrib-xlsxtable/master/sample-excel.png

Rendered HTML:

https://raw.githubusercontent.com/kkAyataka/sphinxcontrib-xlsxtable/master/sample-rendering.png

LICENSE

  • MIT

Project details


Download files

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

Files for sphinxcontrib-xlsxtable, version 0.1.9.dev20200315
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_xlsxtable-0.1.9.dev20200315-py3-none-any.whl (6.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinxcontrib-xlsxtable-0.1.9.dev20200315.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page