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.

Source Distribution

Built Distribution

File details

Details for the file sphinxcontrib-xlsxtable-0.1.9.dev20200315.tar.gz.

File metadata

  • Download URL: sphinxcontrib-xlsxtable-0.1.9.dev20200315.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.4

File hashes

Hashes for sphinxcontrib-xlsxtable-0.1.9.dev20200315.tar.gz
Algorithm Hash digest
SHA256 39b1358617a807a62c6b113c7e2114fce56ec792a8e22587eef06b53d1a4168d
MD5 c643f8aabcbcc9d813379f2c38d66ada
BLAKE2b-256 ac97faeceb40a65c3907192df85d730c01ea29f504f75eaf25ac22ea34137004

See more details on using hashes here.

File details

Details for the file sphinxcontrib_xlsxtable-0.1.9.dev20200315-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_xlsxtable-0.1.9.dev20200315-py3-none-any.whl
Algorithm Hash digest
SHA256 31ebbcc118c8a68624af62425717a0798a85e6e750a50d4f3bfb73d4d4f7d2ef
MD5 178c82a2dbf1007ebe94800c8af2ec3a
BLAKE2b-256 8d5c0db3054280783bf341bb6e7d03ea8b33cabd66ba16fcef53b7a0e5a5b281

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