https://github.com/sphinx-contrib/exceltable

https://github.com/sphinx-contrib/exceltable

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/sphinx-contrib/exceltable
• Owner: sphinx-contrib
• License: mit
• Created: 2017-09-28T14:12:35.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-07-28T12:26:21.000Z (almost 2 years ago)
• Last Synced: 2025-04-07T15:01:29.717Z (about 1 month ago)
• Language: Python
• Size: 218 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

README

        
Module ``sphinxcontrib.exceltable`` is an extension for Sphinx_, which allows to include Excel spreadsheets into beautiful Sphinx -generated documents. 

It is possible to include the whole spreadsheet or just a part of it. 

The extension is compatible with xls, xlsx, xlsm, xltx, xltm, xlsb, ods, odt, and odf files. 

It can also control the formatting of headers and width of the columns. 

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

.. _Sphinx: https://www.sphinx-doc.org/