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.8.dev20200311.tar.gz.

File metadata

  • Download URL: sphinxcontrib-xlsxtable-0.1.8.dev20200311.tar.gz
  • Upload date:
  • Size: 5.0 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.8.dev20200311.tar.gz
Algorithm Hash digest
SHA256 f9663899d92edd16ec3781ed1dca128503bbd7f520ac6da185cdf44d9206ea48
MD5 88e5a427e6f43ba5025756dd5d24e882
BLAKE2b-256 4b7ffc7da40474727332333db55bb93a109d66378ff4e1533214f51d2fd2cd22

See more details on using hashes here.

File details

Details for the file sphinxcontrib_xlsxtable-0.1.8.dev20200311-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_xlsxtable-0.1.8.dev20200311-py3-none-any.whl
Algorithm Hash digest
SHA256 59727ce68785cd6788eab2fadd2e873087d81e5e812088fb8e91cd86a035f23d
MD5 aae09228910f0fe8933c4ca8a86bdcc2
BLAKE2b-256 758703e726f1523c09398e91ca7a1fdfd11b1dbb47eb7eeb70b87d07b30ac97c

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