sphinxcontrib-excel 0.0.1

Installation

You can install it via pip:

$ pip install sphinxcontrib-excel

or clone it and install it:

$ git clone https://github.com/pyexcel/sphinxcontrib-excel.git
$ cd sphinxcontrib-excel
$ python setup.py install

Setup

Please add sphinxcontrib-excel into your conf.py file:

extensions = [
        ...
        'sphinxcontrib.excel',
        ...
    ]

And you will need to copy a few resources file to your sphinx source directory:

resources/_template/layout.html
resources/_static/handsontable.full.min.js
resources/_static/handsontable.full.min.css

Here is the syntax to present your excel file in sphinx documentation:

.. pyexcel-table:: filename.csv

And ‘filename.csv’ is expected in the directory where the referring rst file is. Relative path needs to be given if your file is somewhere else.

For example, the following rst statment:

is translated as:

.. pyexcel-table::

   ---pyexcel:example table---
   Name,Age
   Adam,28
   Beatrice,29
   Ceri,30
   Dean,26

.. pyexcel-table::

   ---pyexcel:Sheet 1---
   1,2,3
   4,5,6
   7,8,9
   ---pyexcel---
   ---pyexcel:Sheet 2---
   X,Y,Z
   1,2,3
   4,5,6
   ---pyexcel---
   ---pyexcel:Sheet 3---
   O,P,Q
   3,2,1
   4,3,2

Support the project

If your company has embedded pyexcel and its components into a revenue generating product, please support me on patreon to maintain the project and develop it further.

If you are an individual, you are welcome to support me too on patreon and for however long you feel like to. As a patreon, you will receive early access to pyexcel related contents.

With your financial support, I will be able to invest a little bit more time in coding, documentation and writing interesting posts.

Development guide

Development steps for code changes

1. git clone https://github.com/pyexcel/sphinxcontrib-excel.git

2. cd sphinxcontrib-excel

Upgrade your setup tools and pip. They are needed for development and testing only:

1. pip install –upgrade setuptools pip

Then install relevant development requirements:

1. pip install -r rnd_requirements.txt # if such a file exists

2. pip install -r requirements.txt

3. pip install -r tests/requirements.txt

In order to update test environment, and documentation, additional steps are required:

1. pip install moban

2. git clone https://github.com/pyexcel/pyexcel-commons.git commons

3. make your changes in .moban.d directory, then issue command moban

$ make

> test.bat

License

New BSD License