Skip to main content

Support for including Excel spreadsheets into Sphinx documents

Project description

Module sphinxcontrib.exceltable is an extension for Sphinx, that adds support for including Excel spreadsheets, or part of them, into Sphinx document. See documentation for further information. It works with Python >=3.7

Installation:

mkdir my-docs
cd my-docs/

# Install dependencies
python3 -v venv
source vevn/bin/activate
pip3 install sphinx sphinxcontrib-exceltable

# Alternatively, install pre-release
# pip3 install sphinxcontrib-exceltable --pre

# Create simple docs
sphinx-quickstart

Configuration:

Enable the extension by adding

extensions = [
  'sphinxcontrib.exceltable'
  # ...other extensions
]

Usage:

My document
===========
The contents of the setup script:

.. exceltable:: Table caption
   :file: path/to/document.xls
   :header: 1
   :selection: A1:B3

Read complete documentation: http://pythonhosted.org/sphinxcontrib-exceltable/ Report issues: https://github.com/sphinx-contrib/exceltable/issues

Development:

# Create virtual environment
python3 -m venv venv3
source venv3/bin/activate

# Install dependencies
python3 -m pip install --upgrade pip
pip3 install -r requirements.txt

# Run tests
PYTHONPATH=$(pwd)/src python3 -m pytest

# Run
python3 -m tox

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

sphinxcontrib-exceltable-0.3.0.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_exceltable-0.3.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file sphinxcontrib-exceltable-0.3.0.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-exceltable-0.3.0.tar.gz
Algorithm Hash digest
SHA256 b99c1fee61dcb0ad191d697f3a1fd38e74e1f0e477a4f415243811ad50e1ae5d
MD5 6acce0c7fe41fa80e91d6690b7b5d555
BLAKE2b-256 4040a38d80512a8b1d3e67e3df126a9e8e3c89aea6fb87285aa684a27f9a3502

See more details on using hashes here.

File details

Details for the file sphinxcontrib_exceltable-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_exceltable-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23898c1099852e986da950d1cf404876b206f6332aaf48e4023e0f027efdbfeb
MD5 306ac8679ad9d613dcd67595157035f7
BLAKE2b-256 b50b228c8f12013ef5edfbde440c558b819c28699c3b8328e98276a5732c92b1

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