{"id":19235186,"url":"https://github.com/pyexcel-renderers/sphinxcontrib-excel","last_synced_at":"2025-10-25T15:13:54.875Z","repository":{"id":87426398,"uuid":"83464004","full_name":"pyexcel-renderers/sphinxcontrib-excel","owner":"pyexcel-renderers","description":"Embed excel file as an excel-alike table into sphinx documentation","archived":false,"fork":false,"pushed_at":"2017-08-20T07:39:10.000Z","size":247,"stargazers_count":13,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-07T05:39:44.530Z","etag":null,"topics":["sphinx-plugin"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pyexcel-renderers.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-02-28T18:08:09.000Z","updated_at":"2022-02-22T16:15:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"360494e4-f6ae-4574-9d60-e4ea12479904","html_url":"https://github.com/pyexcel-renderers/sphinxcontrib-excel","commit_stats":null,"previous_names":["pyexcel/sphinxcontrib-excel"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/pyexcel-renderers/sphinxcontrib-excel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel-renderers%2Fsphinxcontrib-excel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel-renderers%2Fsphinxcontrib-excel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel-renderers%2Fsphinxcontrib-excel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel-renderers%2Fsphinxcontrib-excel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyexcel-renderers","download_url":"https://codeload.github.com/pyexcel-renderers/sphinxcontrib-excel/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel-renderers%2Fsphinxcontrib-excel/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270932578,"owners_count":24670241,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-17T02:00:09.016Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["sphinx-plugin"],"created_at":"2024-11-09T16:16:13.902Z","updated_at":"2025-10-25T15:13:54.779Z","avatar_url":"https://github.com/pyexcel-renderers.png","language":"Python","funding_links":["https://www.patreon.com/pyexcel","https://www.patreon.com/bePatron?u=5537627","https://www.patreon.com/pyexcel/posts"],"categories":[],"sub_categories":[],"readme":"================================================================================\nsphinxcontrib-excel - Let you focus on data, instead of file formats\n================================================================================\n\n.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png\n   :target: https://www.patreon.com/pyexcel\n\n.. image:: https://api.travis-ci.org/pyexcel/sphinxcontrib-excel.svg?branch=master\n   :target: http://travis-ci.org/pyexcel/sphinxcontrib-excel\n\n.. image:: https://codecov.io/gh/pyexcel/sphinxcontrib-excel/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/pyexcel/sphinxcontrib-excel\n\n.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg\n   :target: https://gitter.im/pyexcel/Lobby\n\n\nSupport the project\n================================================================================\n\nIf your company has embedded pyexcel and its components into a revenue generating\nproduct, please `support me on patreon \u003chttps://www.patreon.com/bePatron?u=5537627\u003e`_ to\nmaintain the project and develop it further.\n\nIf you are an individual, you are welcome to support me too on patreon and for however long\nyou feel like to. As a patreon, you will receive\n`early access to pyexcel related contents \u003chttps://www.patreon.com/pyexcel/posts\u003e`_.\n\nWith your financial support, I will be able to invest\na little bit more time in coding, documentation and writing interesting posts.\n\n\n\nIntroduction\n================================================================================\n**sphinxcontrib-excel** uses pyexcel to read an excel files and renders into an excel-alike sheet in your sphinx documentation. The excel file formats are:\n\n#. csv\n#. tsv\n#. csvz\n#. tsvz\n#. xls\n#. xlsx\n#. xlsm\n#. ods\n\n\n\n\nInstallation\n================================================================================\nYou can install it via pip:\n\n.. code-block:: bash\n\n    $ pip install sphinxcontrib-excel\n\n\nor clone it and install it:\n\n.. code-block:: bash\n\n    $ git clone https://github.com/pyexcel/sphinxcontrib-excel.git\n    $ cd sphinxcontrib-excel\n    $ python setup.py install\n\n\n\nSetup\n================================================================================\n\nPlease add sphinxcontrib-excel into your conf.py file::\n\n    extensions = [\n\t    ...\n\t    'sphinxcontrib.excel',\n\t    ...\n\t]\n\nAnd you will need to copy a few resources file to your sphinx source directory::\n\n    resources/_template/layout.html\n    resources/_static/handsontable.full.min.js\n    resources/_static/handsontable.full.min.css\n\n.. note::\n\n   `resources` directory is in github. please check it out.\n\nHere is the syntax to present your excel file in sphinx documentation::\n\n    .. pyexcel-table:: filename.csv\n\nAnd 'filename.csv' is expected in the directory where the referring rst file is.\nRelative path needs to be given if your file is somewhere else.\n\nFor example, the following rst statment:\n\n.. image:: https://github.com/pyexcel/sphinxcontrib-excel/raw/master/sphinx-doc-source.png\n   :alt: table directive\n\nis translated as:\n\n.. image:: https://github.com/pyexcel/sphinxcontrib-excel/raw/master/sphinx-doc-view.png\n   :alt: table view\n\nEmbed csv into your sphinx documentation\n--------------------------------------------------\n\nHere is the syntax for embedded csv, `rendering as a single handsontable \u003chttp://pyexcel.readthedocs.io/en/latest/#usage\u003e`_:\n\n.. code-block::\n\n   .. pyexcel-table::\n\n      ---pyexcel:example table---\n      Name,Age\n      Adam,28\n      Beatrice,29\n      Ceri,30\n      Dean,26  \n\nHere is the complex example for embedded csv, which will be `rendered as\nmulti-tab handsontable \u003chttp://pyexcel.readthedocs.io/en/latest/tutorial_data_conversion.html#how-to-obtain-a-dictionary-from-a-multiple-sheet-book\u003e`_):\n\n\n.. code-block::\n\n   .. pyexcel-table::\n\n      ---pyexcel:Sheet 1---\n      1,2,3\n      4,5,6\n      7,8,9\n      ---pyexcel---\n      ---pyexcel:Sheet 2---\n      X,Y,Z\n      1,2,3\n      4,5,6\n      ---pyexcel---\n      ---pyexcel:Sheet 3---\n      O,P,Q\n      3,2,1\n      4,3,2\n\n\n\nDevelopment guide\n================================================================================\n\nDevelopment steps for code changes\n\n#. git clone https://github.com/pyexcel/sphinxcontrib-excel.git\n#. cd sphinxcontrib-excel\n\nUpgrade your setup tools and pip. They are needed for development and testing only:\n\n#. pip install --upgrade setuptools pip\n\nThen install relevant development requirements:\n\n#. pip install -r rnd_requirements.txt # if such a file exists\n#. pip install -r requirements.txt\n#. pip install -r tests/requirements.txt\n\nOnce you have finished your changes, please provide test case(s), relevant documentation\nand update CHANGELOG.rst.\n\n.. note::\n\n    As to rnd_requirements.txt, usually, it is created when a dependent\n    library is not released. Once the dependecy is installed\n    (will be released), the future\n    version of the dependency in the requirements.txt will be valid.\n\n\nHow to test your contribution\n------------------------------\n\nAlthough `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.\n\nOn Linux/Unix systems, please launch your tests like this::\n\n    $ make\n\nOn Windows systems, please issue this command::\n\n    \u003e test.bat\n\nHow to update test environment and update documentation\n---------------------------------------------------------\n\nAdditional steps are required:\n\n#. pip install moban\n#. git clone https://github.com/moremoban/setupmobans.git # generic setup\n#. git clone https://github.com/pyexcel/pyexcel-commons.git commons\n#. make your changes in `.moban.d` directory, then issue command `moban`\n\nWhat is pyexcel-commons\n---------------------------------\n\nMany information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in `pyexcel-commons` project.\n\nWhat is .moban.d\n---------------------------------\n\n`.moban.d` stores the specific meta data for the library.\n\nAcceptance criteria\n-------------------\n\n#. Has Test cases written\n#. Has all code lines tested\n#. Passes all Travis CI builds\n#. Has fair amount of documentation if your change is complex\n#. Please update CHANGELOG.rst\n#. Please add yourself to CONTRIBUTORS.rst\n#. Agree on NEW BSD License for your contribution\n\n\n\nLicense\n================================================================================\n\nNew BSD License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyexcel-renderers%2Fsphinxcontrib-excel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyexcel-renderers%2Fsphinxcontrib-excel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyexcel-renderers%2Fsphinxcontrib-excel/lists"}